-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Python standard library to Intersphinx mapping #10523
Merged
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
This is good for the resolution of just over 200 failed Sphinx references, almost all of which are from Sphinx attempting to insert links in type hints. Those aren't super important, but it's nice in the vein of being able to use Sphinx's `nitpicky` mode to find places where we have Sphinx references that are failing to resolve, since it silences some of the noise.
jakelishman
added
documentation
Something is not clear or an error documentation
stable backport potential
The bug might be minimal and/or import enough to be port to stable
Changelog: None
Do not include in changelog
labels
Jul 28, 2023
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 5837176497
💛 - Coveralls |
Eric-Arellano
approved these changes
Aug 14, 2023
mtreinish
approved these changes
Aug 14, 2023
mergify bot
pushed a commit
that referenced
this pull request
Aug 14, 2023
This is good for the resolution of just over 200 failed Sphinx references, almost all of which are from Sphinx attempting to insert links in type hints. Those aren't super important, but it's nice in the vein of being able to use Sphinx's `nitpicky` mode to find places where we have Sphinx references that are failing to resolve, since it silences some of the noise. (cherry picked from commit b3b59e9)
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 15, 2023
This is good for the resolution of just over 200 failed Sphinx references, almost all of which are from Sphinx attempting to insert links in type hints. Those aren't super important, but it's nice in the vein of being able to use Sphinx's `nitpicky` mode to find places where we have Sphinx references that are failing to resolve, since it silences some of the noise. (cherry picked from commit b3b59e9) Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
jaeunkim
pushed a commit
to jaeunkim/qiskit-terra
that referenced
this pull request
Aug 15, 2023
This is good for the resolution of just over 200 failed Sphinx references, almost all of which are from Sphinx attempting to insert links in type hints. Those aren't super important, but it's nice in the vein of being able to use Sphinx's `nitpicky` mode to find places where we have Sphinx references that are failing to resolve, since it silences some of the noise.
SamD-1998
pushed a commit
to SamD-1998/qiskit-terra
that referenced
this pull request
Sep 7, 2023
This is good for the resolution of just over 200 failed Sphinx references, almost all of which are from Sphinx attempting to insert links in type hints. Those aren't super important, but it's nice in the vein of being able to use Sphinx's `nitpicky` mode to find places where we have Sphinx references that are failing to resolve, since it silences some of the noise.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Changelog: None
Do not include in changelog
documentation
Something is not clear or an error documentation
stable backport potential
The bug might be minimal and/or import enough to be port to stable
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.
Summary
This is good for the resolution of just over 200 failed Sphinx references, almost all of which are from Sphinx attempting to insert links in type hints. Those aren't super important, but it's nice in the vein of being able to use Sphinx's
nitpicky
mode to find places where we have Sphinx references that are failing to resolve, since it silences some of the noise.Details and comments
Similar to #10522, this is me idly trying to reduce our number of failed Sphinx lookups with a very approximate goal of being able to turn on Sphinx's
nitpicky
mode, since it seems to me like the Terra release manager spends a lot of time trying to verify that all the documentation links in the release nodes actually work. That seems like a giant waste of everyone's time and something that ought to be automatically enforced, if it's not too much of a pain.