Skip to content

Conversation

@Cadair
Copy link
Member

@Cadair Cadair commented Jan 21, 2026

What's our Python and Sphinx version compatibility policy here? We are running some very old sphinx!

Copy link
Member

@pllim pllim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think generally we want to support old versions as much as possible because downstream package using this might not have resources to constantly update. A lot of them got sphinx-astropy dependency from our old astropy package template.

As long as @bsipocz is happy with the bumps, I am too.

Thanks!

extras =
tests
v2deps: confv2
v3deps: confv3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should add v3deps in env list above?

Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not against dropping old python/sphinx versions, but given this is a low level infra package we should not go too crazy with it.

If it were me, I would drop at EOL and bump to the versions that added support for the next oldest version.
If there is a feature that you want to/need to use then dropping the old versions should be fine, but I don't think we should do that just for the sake of dropping. Not a strongly held opinion, so do let me know if you have arguments besides 1-2 fewer CI jobs.

OTOH, changes here look good, I commit the two fixes that are needed, the rest can go in when you all see fit.

description = "Sphinx extensions and configuration specific to the Astropy project"
readme = {file = "README.rst", content-type = "text/x-rst"}
requires-python = ">=3.9"
requires-python = ">=3.10"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think we should keep this and only from EOL. But it's not a strong preference as most packages doesn't really need the ability to build docs on their oldest supported version.

python-version: "3.13"
toxenv: py313-test-v2deps-sphinxdev
python-version: "3.14"
toxenv: py314-test-v2deps-sphinxdev
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please do add a v3 devdeps/sphinxdev job, too. Right now they are the same I think, but that may change.

v2deps: confv2
v3deps: confv3
deps =
sphinx_oldest: sphinx==4.0.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will go upto 4.3 as that's the first one to support py310

Suggested change
sphinx_oldest: sphinx==4.0.0
sphinx_oldest: sphinx==4.3.0

Comment on lines +3 to +4
py{310,311,312,313,314}-test{-v2deps}-sphinx{_oldest,53,62,70,71,72,80,81,82,90,91,dev}
py314-test{-v2deps}-predeps
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
py{310,311,312,313,314}-test{-v2deps}-sphinx{_oldest,53,62,70,71,72,80,81,82,90,91,dev}
py314-test{-v2deps}-predeps
py{310,311,312,313,314}-test-{v2deps,v3deps}-sphinx{_oldest,53,62,70,71,72,80,81,82,90,91,dev}
py314-test-{v2deps,v3deps}-predeps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants