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

Use breathe>=4.27 to support Doxygen \page, \section, etc. #2573

Merged
merged 1 commit into from
Mar 12, 2021

Conversation

mwtoews
Copy link
Member

@mwtoews mwtoews commented Mar 11, 2021

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.

@mwtoews mwtoews requested a review from rouault March 11, 2021 09:44
@mwtoews mwtoews marked this pull request as ready for review March 11, 2021 18:34
@mwtoews
Copy link
Member Author

mwtoews commented Mar 11, 2021

Hmm, with a new container update, a new issue emerges from make spelling:

...
Encoding error:
'ascii' codec can't encode character '\u201c' in position 39: ordinal not in range(128)
The full traceback has been saved in /tmp/sphinx-err-cab77k47.log, if you want to report the issue to the developers.
make: *** [spelling] Error 2
Makefile:43: recipe for target 'spelling' failed

I'm unable to replicate this locally. Also note that python3 -c "print('\u201c')" returns .

@rouault
Copy link
Member

rouault commented Mar 11, 2021

I'm unable to replicate this locally

even within the updated container ?

@rouault
Copy link
Member

rouault commented Mar 11, 2021

Note: I had tagged the previous version of the container as osgeo/proj-docs:2020

@mwtoews
Copy link
Member Author

mwtoews commented Mar 11, 2021

even within the updated container ?

Ok, I am now getting the error with osgeo/proj-docs:latest. However, I'm unable to get the error on my Ubuntu laptop in a fresh venv or conda environment via pip. I'll need to investigate this further ....

@rouault
Copy link
Member

rouault commented Mar 12, 2021

Restarting the Docs job with the updated Docker image

@rouault rouault merged commit b2fde1a into OSGeo:master Mar 12, 2021
@mwtoews
Copy link
Member Author

mwtoews commented Mar 15, 2021

Cherry-picked into 8.0, so now you can see the new layout in this section, or page 429 of the current PDF.

@hobu
Copy link
Contributor

hobu commented Mar 15, 2021

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.

@mwtoews
Copy link
Member Author

mwtoews commented Mar 15, 2021

Is there a way with breathe to suppress index entity creation nowadays?

You mean in the PDF version? Yes I agree, and will take a look to try and suppress this generation.

@mwtoews mwtoews deleted the breathe branch March 4, 2022 09:53
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