Skip to content

Anchor support in toctree #2954

Description

@xoorath

Hey,

I'd like to request the ability to include same-page anchors in toctree.

A syntax similar to:

TOC
:::::::::::::::::::::
.. toctree::

    #constructors
    #set_get_methods
    #operators

Use case:
I'm using breathe to generate my c++ documentation from doxygen and having the ability to include some or all of the permalinks on my page in the table of contents would be desireable. Here's the real world use case for me: (an arbitrary anchor for reference) http://xo-math.readthedocs.io/en/latest/classes/vector4.html#special_operators

In this example doc you'll see I hacked in support for this myself. Having proper support so my TOC shows up in the side bar would be incredible.

Thanks,
Jared

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions