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

When rendering a section, add target after title #647

Merged
merged 1 commit into from
Mar 29, 2021

Conversation

utzig
Copy link
Contributor

@utzig utzig commented Feb 22, 2021

Sphinx's TOC renderer doesn't seem to like adding a target before a title in a section, so just swap the ordering in which the nodes are added; this should not affect the rendering itself.

Fixes #646

Sphinx's TOC renderer doesn't seem to like adding a target before a title in
a section, so just swap the ordering in which the nodes are added; this should
not affect the rendering itself.

Fixes breathe-doc#646

Signed-off-by: Fabio Utzig <utzig@apache.org>
@nicki-krizek
Copy link

I can confirm this fixes the issue.

@vermeeren vermeeren self-requested a review March 29, 2021 00:30
@vermeeren vermeeren self-assigned this Mar 29, 2021
@vermeeren vermeeren added bug Problem in existing code code Source code regression Something broke that worked in the past labels Mar 29, 2021
Copy link
Collaborator

@vermeeren vermeeren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah this change seems like a clean fix, confirmed the output works as expected for the Breathe example page using it (doxygen.html). Thanks!

@michaeljones michaeljones merged commit f5f13bc into breathe-doc:master Mar 29, 2021
michaeljones pushed a commit that referenced this pull request Mar 29, 2021
@utzig utzig deleted the fix-target-issue branch March 29, 2021 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Problem in existing code code Source code regression Something broke that worked in the past
Projects
None yet
Development

Successfully merging this pull request may close these issues.

IndexError when generating toctree
4 participants