WIP - Explicit installation of Sphinx versions #1971
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
trallard
added
tag: dependencies
trallard
commented
Sep 2, 2024
| - os: ubuntu-latest | ||
| python-version: "3.9" | ||
| sphinx-version: "6.1" | ||
| # newest Python version with the newest Sphinx version | ||
| sphinx-version: "6.2" |
There was a problem hiding this comment.
We have been installing 6.1, but I think we should bump it to 6.2
Comment on lines
-226
to
-228
|
|
||
| # to run the tests only without pre-compiling the assets and without coverage (for example if you recently compiled the assets) | ||
| $ tox run -e tests-no-cov |
There was a problem hiding this comment.
Since the compilation is required, let's remove this
Comment on lines
+65
to
+72
| sphinx61: Sphinx>=6.1,<6.2 | ||
| sphinx62: Sphinx>=6.2,<6.3 | ||
| sphinx70: Sphinx>=7.0,<7.1 | ||
| sphinx71: Sphinx>=7.1,<7.2 | ||
| sphinx72: Sphinx>=7.2,<7.3 | ||
| sphinx80: Sphinx>=8.0,<8.1 | ||
| sphinxlatest: Sphinx | ||
| sphinxdev: sphinx[test] @ git+https://github.com/sphinx-doc/sphinx.git@master |
There was a problem hiding this comment.
I erred on adding all versions here but since we are not running tests against all of them I can remove some of them.
There was a problem hiding this comment.
IMO the latest point-release of 6.x, 7.x, 8.x, plus current main is enough
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Partially closes #1938
Inspecting the GitHub actions, I realized we had already been running our tests against the latest version of Sphinx (
8.2), but since we are doing this implicitly, it is easy to miss.I have updated the
tox.iniso that the Sphinx version is always explicitly set. This makes it easier to track which version we are building docs and running tests against.