gh-101100: Fix sphinx warnings in tutorial/appendix.rst#108750
Merged
Uh oh!
There was an error while loading. Please reload this page.
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.
Warnings before:
The problem here is that these module are not documented as
.. module::, they are documented as.. indexinstead https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-indexcpython/Doc/library/site.rst
Lines 112 to 126 in 044b8b3
So, I went with
:index:inline role. This way once some location is added to their definitions (a header, probably) they will automatically link there.📚 Documentation preview 📚: https://cpython-previews--108750.org.readthedocs.build/