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 menus in html documentation when using Doxygen > 1.8.14 #2155

Merged
merged 2 commits into from
May 18, 2020
Merged

Fix menus in html documentation when using Doxygen > 1.8.14 #2155

merged 2 commits into from
May 18, 2020

Conversation

i8-pi
Copy link
Contributor

@i8-pi i8-pi commented May 16, 2020

A flag was added in Doxygen 1.8.14 to restore the old style menus. This change sets that flag

The doxygen config file was updated to the latest version (1.8.18) using doxygen -u. Older doxygen versions that don't recognize the new options will ignore them. I've tested 1.8.11 and 1.8.18

I've also removed the external jQuery reference and the included dynsections.js. We should be using the versions generated with the docs as different version have different bundled dependencies

@januscla
Copy link

Thanks for your contribution, @i8-pi! Please make sure you sign our CLA, as it's a required step before we can merge this.

@lminiero
Copy link
Member

Thanks, this Doxygen thing had been a thorn in our side for quite some time. I'll test and in case it works merge 👍

[],
[
AS_VERSION_COMPARE([$doxygen_version], [1.8.14],
[AC_MSG_ERROR([Doxygen $doxygen_version not usable: versions between 1.8.12 and 1.8.14 are known to render poorly.])],
Copy link
Member

@lminiero lminiero May 18, 2020

Choose a reason for hiding this comment

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

Won't this only be used for version < 1.8.14, and not when it's exactly 1.8.14? If I got the check right, this means that for 1.8.14 this will be considered a success, go on, and since 1.8.14 is affected too, cause broken docs. If so, the check should probably be on 1.8.15? (just as we have 11 instead of 12 in the previous one).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, I did not explain the situation well. The flag to opt out of the new style menu was released in 1.8.14, so 1.8.14 works.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, perfect then, thanks! I was just testing this with the 1.8.15 on Fedora and it works perfectly, so I'll merge 👍

@lminiero lminiero merged commit 49dcd4e into meetecho:master May 18, 2020
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 this pull request may close these issues.

3 participants