-
-
Notifications
You must be signed in to change notification settings - Fork 30.8k
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
gh-101100: Silence Sphinx warnings when ntpath
or posixpath
are referenced
#112833
Conversation
… are referenced
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lovely stuff!
You're going to hit a conflict on backport because |
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. |
…ixpath` are referenced (python#112833) (cherry-picked from commit 2c3906b)
GH-112858 is a backport of this pull request to the 3.11 branch. |
…ixpath` are referenced (python#112833) (cherry-picked from commit 2c3906b)
… are referenced (python#112833)
… are referenced (python#112833)
ntpath
andposixpath
are 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_ignore
list inDoc/conf.py
. Doing this allows us to removelibrary/os.path.rst
from the.nitignore
list of files.📚 Documentation preview 📚: https://cpython-previews--112833.org.readthedocs.build/