Skip to content

docs: change documentation hierachy to make space for adding more pages#47

Open
HennerM wants to merge 1 commit intomainfrom
docs-hierachy
Open

docs: change documentation hierachy to make space for adding more pages#47
HennerM wants to merge 1 commit intomainfrom
docs-hierachy

Conversation

@HennerM
Copy link
Collaborator

@HennerM HennerM commented Feb 6, 2026

The documentation index is currently duplicated across the index and the index pages of subpages. In the main index we linked to each page in the guides section, and did this again in the index for the guides. The guides/index is also only linked on the main index and doesn't contain more information than already found in the sidebar which is always visible.

This setup doesn't make it easy to add more pages, as I found when adding documentation for the tracker docs.

My proposal now is to add more information to the sub-index pages that for the noether and tutorial sections and remove the sublinks there, for the guides which right now is the biggest section, we can just use the link to guides/index and have the subpages linked there, this makes the section collapsible which reduces visual clutter and avoids duplication of the links. Then for the reference section I remove the index completely because it just contains two links that were already linked in the sidebar

Some other additons for smoother docs

  • moved hardware allocation & training configurations to reference, because it's not a how-to
  • moved the Zoos into the first "The Noether Framework" section to have them further up and more prominent
  • Enable imported-members in the autoapi generation: this shows re-exports directly in the re-exported hierachy. E.g. noether.core.callbacks.base.CallbackBase that is reexported as noether.core.callbacks.CallbackBase now shows up on the noether.core.callbacks page already. This makes it easier to hide the "internal" modules. This was also the reason some of the links generated by autoapi based on the type-hints were not working because we would use the re-exported import internally as well that did not have a documentation page.
  • I made the tutorial just a link in the sidebar, instead of a page that just contains a link
  • I fixed some of the docstrings that were showing up as Sphinx warnings because they used the wrong syntax.

@github-actions
Copy link

github-actions bot commented Feb 6, 2026

Coverage

Tests Skipped Failures Errors Time
917 12 💤 0 ❌ 0 🔥 26.751s ⏱️

@HennerM
Copy link
Collaborator Author

HennerM commented Feb 10, 2026

@MauritsBleeker can you take a look at this?

@Ndles
Copy link
Member

Ndles commented Feb 11, 2026

thanks for making the adjustments, checked it locally - looks good 👍

@github-actions
Copy link

Docs publish only on push to main/dev-refactoring. Live site: https://noether-docs.emmi.ai/

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants