Recommend recent Sphinx for GitHub Pages #13055
Conversation
sphinx-action runs Python 3.8 on its master branch, which may fail even if you force upgrading sphinx in the requirements file. Recommend a newer base docker image.
jayaddison
added
dependencies
There was a problem hiding this comment.
Looks good to me. Initially I thought that this was an update to the GHA workflows for Sphinx, but on second glance realized that it is an update to example documentation we publish.
I performed a few basic checks, such as confirming that the associated git tag currently points through to an official u/sphinxdoc container image.
The sphinx-actions repo includes some automation that intentionally pushes tagged releases to off-branch commit tags for each Docker Hub version of Sphinx found on a daily basis; I find the off-branch element of that a little quirky, but I don't have any particular problem with it.
| @@ -189,7 +189,7 @@ contents: | |||
| steps: | |||
| - uses: actions/checkout@v4 | |||
| - name: Build HTML | |||
| uses: ammaraskar/sphinx-action@master | |||
| uses: ammaraskar/sphinx-action@8.0.2 | |||
| - name: Upload artifacts | |||
| uses: actions/upload-artifact@v4 | |||
| with: | |||
There was a problem hiding this comment.
Commenting as near to the relevant line as the GitHub web interface will allow me:
Perhaps we should consider updating the peaceiris/actions-gh-pages action at the same time? The differences between v3 and v4 of that plugin appear to be minimal, and are largely dependency-updates.
|
I don't want to merge this yet as it's a reminder to change a couple of things I've been meaning to. I'm also not at a computer, annoyingly. |
1 similar comment
This comment was marked as duplicate.
This comment was marked as duplicate.
cc @nicholasphair because I shouldn't subtweet (or whatever the modern equivalent of that is called) you about this. |
sphinx-action runs Python 3.8 on its master branch, which may fail even if you force upgrading sphinx
in the requirements file.
Recommend a newer base docker image (there doesn't seem to be a rolling "latest" tag available).