-
Notifications
You must be signed in to change notification settings - Fork 789
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
Use breathe>=4.27 to support Doxygen \page, \section, etc. #2573
Conversation
Hmm, with a new container update, a new issue emerges from
I'm unable to replicate this locally. Also note that |
even within the updated container ? |
Note: I had tagged the previous version of the container as osgeo/proj-docs:2020 |
Ok, I am now getting the error with |
Restarting the Docs job with the updated Docker image |
Cherry-picked into 8.0, so now you can see the new layout in this section, or page 429 of the current PDF. |
Is there a way with breathe to suppress index entity creation nowadays? It makes a sloppy mess of the indexes, and I think our indexes would be better off with a few manual entries pointing to the beginning of the API section rather than the auto-generated entries which take up a bunch of space and add little. |
You mean in the PDF version? Yes I agree, and will take a look to try and suppress this generation. |
This PR removes two hacks that I think are no longer needed.
The big one is to use recent breathe features, mainly breathe-doc/breathe#635 which is part of version 4.27
With the rendered output, the layout of cpp_general for both html and pdf is generally improved, but with more structured headers. Cross-references to node names in this section also work as expected.
The second removed hack is to not follow the bug workaround for Doxygen 1.8.17, and to just throw an error instead. This is partly because the need for a
tmp_breathe
directory (used for the breathe hack) was removed.