-
Notifications
You must be signed in to change notification settings - Fork 320
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
WIP - Explicit installation of Sphinx versions #1971
base: main
Are you sure you want to change the base?
Conversation
- 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have been installing 6.1
, but I think we should bump it to 6.2
|
||
# 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the compilation is required, let's remove this
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO the latest point-release of 6.x, 7.x, 8.x, plus current main is enough
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.ini
so that the Sphinx version is always explicitly set. This makes it easier to track which version we are building docs and running tests against.