Add sphinx.ext.linkcode to link API docs directly to GitHub source - #1176
Closed
viknesh-ai wants to merge 1 commit into
Closed
Add sphinx.ext.linkcode to link API docs directly to GitHub source#1176viknesh-ai wants to merge 1 commit into
viknesh-ai wants to merge 1 commit into
Conversation
Replaces sphinx.ext.viewcode (which copies source into the built docs) with sphinx.ext.linkcode, so each "[source]" link on readthedocs points straight to the corresponding line range on GitHub, following the same pattern used by numpy and pandas. Falls back to the `main` branch when stumpy.__version__ isn't a resolvable release version (e.g. editable installs). Fixes stumpy-dev#1081
|
Review these changes at https://app.gitnotebooks.com/stumpy-dev/stumpy/pull/1176 |
|
❌ This pull request has been automatically closed because the mandatory PR template was removed or not filled out. Please reopen or recreate this PR with the required information. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces sphinx.ext.viewcode (which copies source into the built docs) with sphinx.ext.linkcode, so each "[source]" link on readthedocs points straight to the corresponding line range on GitHub, following the same pattern used by numpy and pandas.
Fixes #1081