agogo theme: ensure hidden toctree is show on Table of Contents #6679
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
The hidden option for the toctree directive is meant to hide from the document at the location of the directive. This for when the links are to be inserted in the HTML sidebar. However, since version 1.2, the toctree() template function requires the includehidden=True option.
|
Hi. This PR was closed but seems that the issue is not fixed yet. Did I miss something? |
|
I meant to label this PR rather than close it -- thanks for catching. I've gone through the others I triaged & seen no other similar errors. A |
|
CI failing due to psf/requests#6140 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The hidden option for the toctree directive is meant to hide from the
document at the location of the directive. This for when the links
are to be inserted in the HTML sidebar. However, since version 1.2,
the toctree() template function requires the includehidden=True
option.
Using the agogo theme, if a document has the toctree set to hidden (because one wants to have it displayed on the sidebar instead of inserted in the document), then the Table of Contents on the side bar will be empty. This fixes it by setting
includehidden=Truewhen callingtoctree()template function. This is required since sphinx 1.2.I am not sure if the same should be done to
sphinx/themes/basic/globaltoc.html