-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Anchor support in toctree #2954
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
I'm not sure what you're trying to suggest I look at in there, @shibukawa. I don't see anything related to anchors or internal links in that document. Maybe I'm missing it, or not describing the suggestion very well? |
Has this been solved yet? I literally have this identical problem with breathe: https://stackoverflow.com/questions/70958524/can-sphinx-auto-generate-a-table-of-contents-from-all-anchors-on-a-page Admittedly its more an issue with breadth itself. Its only able to dump a massive single page of all its documentation and has no built in way of generating a toc- it seriously limits its usefulness. BUT it at least has an anchor for every class/interface/etc on that page. So if there is some way of telling sphinx to create a toc where every item is an anchor on the page that would be a nice way of working around the limitations of breathe. If there isn't a built in way to do this is there some plugin that adds this ability? I've used plugins that add some cool referencing features that you don't get ootb like |
Hey,
I'd like to request the ability to include same-page anchors in toctree.
A syntax similar to:
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
The text was updated successfully, but these errors were encountered: