Doc: Generate Pathlib table with autosummary #126753
Draft
+126
−0
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a test in response to #126342 (comment).
@barneygale This is what it looks like with sphinx.ext.autosummary. The table is effectively included in the page, but not all members are present, there is no formatting and no link in the short descriptions, and I don't think that we can add intermediate titles. Also the Sphinx log shown unrelated errors in the log. Event if the errors were fixed, my conclusion is that the page would be easier to maintain, but at the cost of readability in the documentation.
📚 Documentation preview 📚: https://cpython-previews--126753.org.readthedocs.build/
Edit: Oh well, when there are warnings the preview is not available. Here is what it looks like on my computer: