Improve schema handling in documentation #705
Merged
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
ahal
force-pushed
the
ahal/push-xtusqkostmqv
branch
2 times, most recently
from
6f7383b to
4f4e7eb
Compare
Collaborator
Author
|
Please don't spend overly long trying to parse autoschema.py, unless you're a masochist.. the bar I'm going for here is "better than before" rather than perfect. |
The `#:` syntax is a special format that tells autodoc to include the following object. This is better than using `:undoc-members:` which would otherwise include every global variable in the modules.
ahal
force-pushed
the
ahal/push-xtusqkostmqv
branch
from
4f4e7eb to
4c60f93
Compare
bhearsum
approved these changes
Jun 18, 2025
Contributor
bhearsum
left a comment
bhearsum
left a comment
There was a problem hiding this comment.
I am not a masochist, so this is somewhat a rubberstamp, but it seems to accomplish the goal, and seeing as autoschema.py is not shipping code, I don't think it needs an in-depth review.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Alright this one is a bit silly, but it's something that's been bugging me for a really long time. First, this was partly made with AI. I used it to get the basic structure in place for a Sphinx extension that can modify only Schema instances. But then I made heavy manual modifications on top to get it to look the way I wanted and handle all sorts of edge cases.
Second, I don't expect any reviewers to actually dig in and understand how the autoschema.py works. I'm happy to walk through anything that folks want. But maybe a better way to illustrate what it's doing is with some before / after screenshots.
Before:
After:
