Skip to content

Feature request: alternate titles for sidebar #3906

Open
@Jellby

Description

@Jellby

It is possible to write alternate titles for elements in a TOC, as shown in http://www.sphinx-doc.org/en/stable/markup/toctree.html

.. toctree::

   intro
   All about strings <strings>
   datatypes

where All about strings replaces whatever title is defined in the strings file. However, this does not affect the sidebar (using a custom variant of the agogo theme), and as far as I can see there is no way to modify titles in the sidebar. Since the sidebar has a limited width, it is often desirable to provide shorter titles for the sidebar. If this is implemented, it should be independent of whatever alternate title specified in the toctree directive, as one may want the "normal" title in the TOC but a short title in the sidebar.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions