Skip to content
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

Support Sphinx ToC generation with _toc_name and _toc_parts attribute #958

Open
scottamain opened this issue Oct 24, 2023 · 0 comments · May be fixed by #959
Open

Support Sphinx ToC generation with _toc_name and _toc_parts attribute #958

scottamain opened this issue Oct 24, 2023 · 0 comments · May be fixed by #959

Comments

@scottamain
Copy link

When generating Sphinx/RST nodes from the Doxygen sources, I'd like Breathe to include the short API member name in the _toc_name and _toc_parts attribute of the desc_signature node. This will enable use of Sphinx table of contents, as originally implemented here: sphinx-doc/sphinx#10807

This attribute would also be available for use from alternative renderers. For example, in a Markdown renderer, I can chose to print the short _toc_name instead of the full signature in a heading. That is, instead of the full signature as a heading like this:

## const char \*M_getError(const [M_Status](types.md#_CPPv48M_Status) \*status)

I could have one like this (using the value from _toc_name):

## M_getError

Thanks for your consideration and all your work on Breathe! ❤️

@scottamain scottamain linked a pull request Oct 24, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant