Change source links to github #4113
Merged
Conversation
This file contains 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
github-actions
bot
added
the
documentation
|
@jorgepiloto and @Revathyvenugopal162, you may consider making the changes implemented here into a general purpose sphinx extension as I think it's quite useful to link to github. |
Codecov Report
@@ Coverage Diff @@
## main #4113 +/- ##
=======================================
Coverage 95.56% 95.56%
=======================================
Files 94 95 +1
Lines 20213 20246 +33
=======================================
+ Hits 19316 19349 +33
Misses 897 897 |
|
@MatthewFlamm, seems that #4111 indeed fixed codecov. |
tkoyama010
requested changes
Mar 10, 2023
Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com>
akaszynski
added a commit
that referenced
this pull request
Mar 10, 2023
* add linkcode * Update pyvista/utilities/docs.py Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com> --------- Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com>
Merged
akaszynski
added a commit
that referenced
this pull request
Mar 11, 2023
* bump to 0.38.4 * update req in earnest * fix plotter reopening (#4102) * Update testing-and-deployment.yml * Update requirements_test.txt Co-authored-by: MatthewFlamm <39341281+MatthewFlamm@users.noreply.github.com> * Update testing-and-deployment.yml * Apply suggestions from code review * Change source links to github (#4113) * add linkcode * Update pyvista/utilities/docs.py Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com> --------- Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com> * Fix Plotter docs (#3968) --------- Co-authored-by: MatthewFlamm <39341281+MatthewFlamm@users.noreply.github.com> Co-authored-by: Tetsuo Koyama <tkoyama010@gmail.com> Co-authored-by: Bane Sullivan <bane.sullivan@kitware.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The
mnelibray usessphinx.ext.linkcoderather thansphinx.ext.viewcodeand they link directly to github:mne.io.read_raw
This PR implements the same logic and uses a source link to GitHub. It's much cleaner than having source within our documentation, and it has the (minor) added advantage of decreasing the build time and size of our docs.