docs(api): Change structure to enable dropdowns in sidebar #1325
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
auguste-probabl
force-pushed
the
dropdowns
branch
from
7c3143a to
be82ec6
Compare
MarieSacksick
approved these changes
Feb 14, 2025
glemaitre
reviewed
Feb 14, 2025
glemaitre
reviewed
Feb 14, 2025
glemaitre
approved these changes
Feb 14, 2025
|
I'll address my comment in a follow-up PR when working on #1328. Having those changes will be pretty handy ;) |
|
Many thanks! 🙏 |
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.
Our sphinx theme automatically adds dropdowns in the sidebar when the docs are nested in directories and subdirectories. This PR changes the structure of the docs to enable dropdowns.
One trade-off is that
toctreeandautosummarycannot both be used, so in the API index page, we no longer have a table-formatted list of all the public API functions and classes.Before:
After:
Supersedes #1302
Closes #1095
Co-authored-by: Guillaume Lemaitre [email protected]