Hi sphinx-users,
For the documentation I write, I would like to add a custom caption to
the sidebar. The code bellow worked well until I updated to Sphinx 1.5.3:
|Contents -------- .. toctree:: :hidden: :caption: Libdynamixel ..
toctree:: :maxdepth: 2 self tutorials/index |
Since the update, the hidden toctree is actually hidden from both the
table of contents and the sidebar. I wouldn’t like to add the caption to
a non-hidden toctree since it would add the caption in the document
where the toctree is written (just bellow |Contents|).
The official documentation
<http://www.sphinx-doc.org/en/stable/markup/toctree.html?highlight=hidden>
seems to still support the use case :
You can also give a “hidden” option to the directive, like this:
|.. toctree:: :hidden: doc_1 doc_2 |
This will still notify Sphinx of the document hierarchy, but not
insert links into the document at the location of the directive –
this makes sense if you intend to insert these links yourself, in a
different style, or in the HTML sidebar.
Could you help me understand what caused this change and how to make the
sidebar captioned again ?
Thanks,
Dorian
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
