Title: gh-101100: Silence Sphinx warnings when `ntpath` or `posixpath` are referenced by AlexWaygood · Pull Request #112833 · python/cpython · GitHub
Open Graph Title: gh-101100: Silence Sphinx warnings when `ntpath` or `posixpath` are referenced by AlexWaygood · Pull Request #112833 · python/cpython
X Title: gh-101100: Silence Sphinx warnings when `ntpath` or `posixpath` are referenced by AlexWaygood · Pull Request #112833 · python/cpython
Description: ntpath and posixpath 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 of os.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 in Doc/conf.py. Doing this allows us to remove library/os.path.rst from the .nitignore list of files. Issue: gh-101100 📚 Documentation preview 📚: https://cpython-previews--112833.org.readthedocs.build/
Open Graph Description: ntpath and posixpath 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 of os.pat...
X Description: ntpath and posixpath 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 o...
Opengraph URL: https://github.com/python/cpython/pull/112833
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/checks(.:format) |
| route-controller | pull_requests |
| route-action | checks |
| fetch-nonce | v2:11511d6b-1bb5-f9a5-00d7-0b3a6ad087b8 |
| current-catalog-service-hash | 87dc3bc62d9b466312751bfd5f889726f4f1337bdff4e8be7da7c93d6c00a25a |
| request-id | 965A:1025CE:9A9001:CEE345:6969C0A1 |
| html-safe-nonce | 61b38d18badc85855ea694ad19b79abf0bb5d98921d3be6477cc7f221e1f2489 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5NjVBOjEwMjVDRTo5QTkwMDE6Q0VFMzQ1OjY5NjlDMEExIiwidmlzaXRvcl9pZCI6IjMwOTM3ODY2MjU3OTU4MDEyNDkiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 263486c9493947770f786b01fc5b065badd19384b55bee77d7eb8dfab4d67752 |
| hovercard-subject-tag | pull_request:1634631154 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,checks,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/python/cpython/pull/112833/checks |
| twitter:image | https://avatars.githubusercontent.com/u/66076021?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/66076021?s=400&v=4 |
| og:image:alt | ntpath and posixpath 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 of os.pat... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | acedec8b5f975d9e3d494ddd8f949b0b8a0de59d393901e26f73df9dcba80056 |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive full-width full-width-p-0 |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 83c08c21cdda978090dc44364b71aa5bc6dcea79 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width