Add python intersphinx mapping #3876
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
Codecov Report
@@ Coverage Diff @@
## develop #3876 +/- ##
========================================
Coverage 77.18% 77.18%
========================================
Files 457 457
Lines 33779 33779
========================================
Hits 26072 26072
Misses 7707 7707
Continue to review full report at Codecov.
|
|
This is great @ltalirz , thanks. I think it would maybe also be good to add |
Right - there was no docs for plumpy on RTD (fixed it just now), and the one from kiwipy was not linked from the readme (opened PRs). |
Add intersphinx mapping to python standard library documentation and of various direct dependency libraries: * `click` * `flask` * `flask_restful` * `kiwipy` * `plumpy` Adding this documentation interconnection allows references in our docs like :py:exc:`ValueError` to now directly link to the relevant external documentation. This also allows to cut down the "nitpick exceptions" quite dramatically.
sphuber
force-pushed
the
add-python-intersphinx
branch
from
2073327 to
4f24698
Compare
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.
Add intersphinx mapping to python standard library documentation, i.e.
things like :py:exc:
ValueErrornow link directly there.This also allows to cut down the "nitpick exceptions" quite
dramatically.
Note: I will rebase this PR after #3875 is merged