Repository navigation
sdk/docs: Improve sphinx autodoc structure - #633
Merged
s-heppner merged 9 commits intoNov 13, 2026
Merged
Conversation
ubuntu-20.04 is deprecated
by moving package names out of titles, kept as "subtitles"
Maybe controversial, but if its private it should not live in public documentation. Documentation is also very thin on _string_constraints. _helper is documented more.
Missed earlier
Remove undocumented elements Improve navbar navigation Imrpove ordering
Otherwise nitpicky (-n) compile does not succeed marked as orphan so they dont show up in navbar
Previously, the comment above `autodoc_default_options` stated that only public members are documented. However, `undoc-members` was reintroduced in a51d717, since undocumented members are referenced elsewhere, so the comment no longer matched the configuration. This updates the comment to reflect that undocumented members are included as well.
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
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.
Previously, the RTD documentation contained method headers where they did not belong.
This is now resolved with some more improvements as well:
Fixes #473
The best way to check out the resulting documentation is to build it locally (
sdk/docs/make.bat).