Add support for building documentation with latest sphinx #2695
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. |
neofelis2X
force-pushed
the
docs_sphinx_latest
branch
from
6e20b09 to
4270f92
Compare
|
Sphinx 8.2.0 recently dropped support for Python 3.10. The workflow is using python 3.9. |
|
The furthest you can go, the more headroom we have until it gets dropped again, and probably better support for inspecting type annotations (I assume). And 3.11 had great performance improvements, the others still improve a bit, but 3.11 was a great step |
|
I agree, feel free to bump it up (to 3.13 even!). |
|
Great, 3.13 it is then. I tested the build with 3.13 on windows and macos, so that should be good. |
| @@ -259,6 +260,7 @@ def run(): | |||
| #----------------------------------------------------------------- | |||
| tools.doCommonTweaks(module) | |||
| tools.runGenerators(module) | |||
| postprocess.categorise_methods() | |||
There was a problem hiding this comment.
It looks like the sdist build is failing on CI/CD due to this change. Is this really the right place where this should run? It seems like it is depending on the docs having been built already?
As discussed in #2672, this unpins sphinx and makes building the documentation with latest sphinx (currently 8.2.1) 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:
See new look of inheritance diagrams
Fixes #2672
Fixes #2608
Fixes #2625
Edit: Updated inheritance diagrams and added a screenshot here.
Edit 2: Added missing dependencies and tested with latest sphinx.