doc: mark toctree :hidden:, remove search/modindex #7
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
Package doc toctrees need to be marked `:hidden:` or their ToC will be included in the main opendylan.org ToC. That's not a problem, per se, but it also means (apparently) that the title of the document is included in the opendylan.org ToC, which I don't want; I want each package's ToC entry to be only the name of the package, for consistency. Also removing the `modindex`, which is Python specific, and `search` which is not needed with the Furo theme.
fraya
approved these changes
May 10, 2024
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.
Package doc toctrees need to be marked
:hidden:or their ToC will be included in the main opendylan.org ToC. That's not a problem, per se, but it also means (apparently) that the title of the document is included in the opendylan.org ToC, which I don't want; I want each package's ToC entry to be only the name of the package, for consistency.Note that if the
:hidden:toctree is the top-level toctree, the:hidden:annotation is ignored (at least by the Furo theme). So the toctree is still displayed in the left nav when the package's doc is deployed by itself, outside of opendylan.org.Also removing the
modindex, which is Python specific, andsearchwhich is not needed with the Furo theme.