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

Fix anchors on pages generated by Doxygen>=1.8.17 #602

Merged
merged 1 commit into from
Dec 1, 2020

Conversation

utzig
Copy link
Contributor

@utzig utzig commented Dec 1, 2020

Doxygen has changed the structure of generated XML slightly since version 1.8.13 for "page" generation. Before it would put the anchor inside a <varlistentry><term> block, and on version 1.8.17 and newer, it inserts the anchor inside the matching <listitem><para>.

The <variablelist> block structure is still the same, so this commit only adds support for parsing anchors inside a <para> so it works on both XML generated by old and new versions of Doxygen.

Doxygen has changed the structure of generated XML slightly since
version 1.8.13 for "page" generation. Before it would put the anchor
inside a `<varlistentry><term>` block, and on version 1.8.17 and newer,
it inserts the anchor inside the matching `<listitem><para>`.

The `<variablelist>` block structure is still the same, so this commit
only adds support for parsing anchors inside a `<para>` so it works on
both XML generated by old and new versions of Doxygen.

Signed-off-by: Fabio Utzig <[email protected]>
@utzig
Copy link
Contributor Author

utzig commented Dec 1, 2020

@vermeeren This will be required for GH workflows in the near future since Github started upgrading them to Ubuntu focal which bundles Doxygen 1.8.17 (previous Ubuntu releases bundled 1.8.13). I usually use the same version as the CI so that's why I'd not seen this issue before!

@vermeeren vermeeren self-assigned this Dec 1, 2020
@vermeeren vermeeren added bug Problem in existing code code Source code regression Something broke that worked in the past labels Dec 1, 2020
@vermeeren
Copy link
Collaborator

@utzig Thanks for the fix, I also didn't notice either locally as Debian buster also has Doxygen 1.8.13, so it worked properly so far. Will bump version and release after merging this.

michaeljones pushed a commit that referenced this pull request Dec 1, 2020
@michaeljones michaeljones merged commit 0cb56f9 into breathe-doc:master Dec 1, 2020
@vermeeren
Copy link
Collaborator

Done, release made and of course also pushed to PyPI as usual. Cheers!

@utzig utzig deleted the fix-new-page-anchor branch January 8, 2021 09:46
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.

3 participants