docs: add linkcode extension #261
Conversation
|
Thanks for the pull request, @BryanttV! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
openedx-webhooks
added
the
open-source-contribution
docs/conf.py
Outdated
|
|
||
| REPO_URL = "https://github.com/openedx/openedx-filters/blob/main" | ||
|
|
||
| def linkcode_resolve(domain, info): |
There was a problem hiding this comment.
Can we add some docs on how this works and how it is used?
docs/conf.py
Outdated
| filename = source_file.replace("\\", "/").split("/")[-3:] | ||
| filename = "/".join(filename) | ||
|
|
||
| return f"{REPO_URL}/{filename}#L{start_line}-L{start_line + len(source_lines) - 1}" |
There was a problem hiding this comment.
Can we check why this specific case doesn't work? https://docsopenedxorg--261.org.readthedocs.build/projects/openedx-filters/en/261/reference/filters-tooling.html#openedx_filters.tooling.OpenEdxPublicFilter
There was a problem hiding this comment.
Also, can you help me replace references for that class in the other documents?
docs/conf.py
Outdated
| try: | ||
| file_path = inspect.getsourcefile(obj) | ||
| except Exception: | ||
| file_path = None | ||
| if not file_path: | ||
| try: | ||
| file_path = inspect.getsourcefile(sys.modules[obj.__module__]) | ||
| except Exception: | ||
| file_path = None | ||
| if not file_path: | ||
| return None |
There was a problem hiding this comment.
This section is kind of hard to understand. Can you add an inline comment in case we need to modify it later on?
BryanttV
force-pushed
the
bav/add-link-code-extension
branch
from
b4af74a to
b4bb645
Compare
Description
This PR adds the linkcode Sphinx extension to include the source code in the classes, functions, and methods in the documentation.
Testing instructions
You can check the updated documentation in the checks of this PR.
Screenshots
Before
After
Deadline
N/A
Other information
N/A
Checklists
Check off if complete or not applicable:
Merge Checklist:
Post Merge:
finished.