gh-101100: Silence Sphinx warnings when ntpath or posixpath are referenced
#112833
Conversation
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
… are referenced
AlexWaygood
added
needs backport to 3.11
Contributor
|
You're going to hit a conflict on backport because |
hugovk
approved these changes
Dec 7, 2023
|
Thanks @AlexWaygood for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
|
Sorry, @AlexWaygood, I could not cleanly backport this to |
|
Sorry, @AlexWaygood, I could not cleanly backport this to |
|
GH-112857 is a backport of this pull request to the 3.12 branch. |
AlexWaygood
added a commit
to AlexWaygood/cpython
that referenced
this pull request
Dec 7, 2023
…ixpath` are referenced (python#112833) (cherry-picked from commit 2c3906b)
|
GH-112858 is a backport of this pull request to the 3.11 branch. |
AlexWaygood
added a commit
to AlexWaygood/cpython
that referenced
this pull request
Dec 7, 2023
…ixpath` are referenced (python#112833) (cherry-picked from commit 2c3906b)
aisk
pushed a commit
to aisk/cpython
that referenced
this pull request
Feb 11, 2024
… are referenced (python#112833)
Glyphack
pushed a commit
to Glyphack/cpython
that referenced
this pull request
Sep 2, 2024
… are referenced (python#112833)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
ntpathandposixpathare undocumented modules, and I think they should stay undocumented. The vast majority of users won't need to worry about them; they're implementation details ofos.path.This PR silences Sphinx warnings when these modules are referenced (because Sphinx cannot resolve the references) by adding them to the
nitpick_ignorelist inDoc/conf.py. Doing this allows us to removelibrary/os.path.rstfrom the.nitignorelist of files.📚 Documentation preview 📚: https://cpython-previews--112833.org.readthedocs.build/