Skip to content

sdk/docs: Improve sphinx autodoc structure - #633

Merged
s-heppner merged 9 commits into
eclipse-basyx:developfrom
rwth-iat:improve/sphinx-auto-doc-structure
Nov 13, 2026
Merged

s-heppner merged 9 commits into
eclipse-basyx:developfrom
rwth-iat:improve/sphinx-auto-doc-structure

Conversation

@JAB1305

@JAB1305 JAB1305 commented Sep 18, 2026 •

Copy link
Copy Markdown
Contributor

Previously, the RTD documentation contained method headers where they did not belong.
This is now resolved with some more improvements as well:

  • Fix methods leaking into TOC
  • Order elements by source rather than alphabetically
  • Move package names out of titles, keep as subtitles
  • Remove numbering from headings
  • Split tutorials / examples from API documentation
  • Remove private modules from documentation
  • Fix 2 typos (not fully checked)

Fixes #473

The best way to check out the resulting documentation is to build it locally (sdk/docs/make.bat).

JAB1305 and others added 9 commits September 18, 2026 15:18
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.
@s-heppner
s-heppner merged commit bcb4daf into eclipse-basyx:develop Nov 13, 2026
20 checks passed
@s-heppner
s-heppner deleted the improve/sphinx-auto-doc-structure branch November 13, 2026 13:01

@s-heppner s-heppner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bit late, but this LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants