Use Python 3.11 instead of 3.10 in the doc builiding - #895
Conversation
AVHopp
changed the title
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation build jobs to run on Python 3.11 instead of Python 3.10, aligning CI/doc workflows with the newer sphinx-apidoc-typehints support needed for the current docs build/linkcheck separation.
Changes:
- Renamed the tox docs environment from
docs-py310todocs-py311. - Updated GitHub Actions workflows (
ci,regular,docs) to set up Python 3.11 and invoketox -e docs-py311. - Added a changelog entry documenting the docs build Python version bump.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
tox.ini |
Renames the docs tox env to docs-py311 to match the new docs-build interpreter target. |
CHANGELOG.md |
Notes the switch to Python 3.11 for building documentation. |
.github/workflows/regular.yml |
Updates the scheduled/regular docs job to use Python 3.11 and docs-py311. |
.github/workflows/docs.yml |
Updates the docs workflow to use Python 3.11 and docs-py311. |
.github/workflows/ci.yml |
Updates the CI docs build step to use Python 3.11 and docs-py311. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This is necessary as we need to update one of the sphinx related packages for suppressing some of the errors that are now surfacing due to the separated build of the doc building and the link checking
b538473 to
92152d3
Compare
Co-authored-by: Martin Fitzner <martin.fitzner@merckgroup.com>
There was a problem hiding this comment.
@Scienfitz @AdrianSosic it might (not sure yet) turn out that we do not need this PR as some of the things related to linkchecking might change, we'll probably need to discuss this. Do we want to update the python version for doc building anyway or only if necessary?
There was a problem hiding this comment.
if its not needed and no other reason for the upgrade transpires it shouldn't be done
This PR bumps the python version used in the doc building jobs to 3.11.
This is necessary due to the way that our guarded forward references are handled. Since doc building and link checking are separateed now, the actual doc building does not have access to already "compiled" files. As a consequence, it cannot check and verify that the references can actually resolve. We thus need to ignore errors coming from those references. However, the corresponding option is only available in a newer version of sphinx-apidoc-typehints which is not available on python 3.10 and hence requires us to update to python 3.11.
Stack created with GitHub Stacks CLI • Give Feedback 💬