-
Notifications
You must be signed in to change notification settings - Fork 524
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
Add support for building documentation with latest sphinx #2695
base: master
Are you sure you want to change the base?
Conversation
Ok so I looked into why the build workflow failed. The Problem:The "new" doxygen version is linked against The good news:Ubuntu 22.04 has My proposed solution:
Please let me know what you think of that. I'm not much of a linux person, but that's how I would solve this complication. |
Does doxygen work correctly with a static build? Is it tied to llvm? |
I didn't try that, should work in theory. |
I don't think we should just upload the ubuntu binary to wxPython tools. Then it technically might work in our CI but it won't work for anyone else. Ideally, we would use a statically linked doxygen that doesn't require external dependencies (or I suppose include the dependencies?) which is how the current doyxgen build works. It would be nice if we could keep that property. |
As discussed in #2672, this unpins sphinx and makes building the documentation with latest sphinx (currently 8.1.3) possible.
A current build of the documentation can be viewed here. This test page will be deleted later.
The sphinx build process was tested locally with macOS and Windows, with python 3.9 and 3.13.
To get the docs to look and work as before, a few fixes were needed. Mostly changes to the sphinx config and the post-processing script.
A rough overview of the changes:
Fixes #2672
It also relates to #2608 but I did not update the inheritance diagrams yet.