Skip to content

Python Environment: Use latest theme on all sphinx versions #8073

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

Closed
wants to merge 2 commits into from

Conversation

Blendify
Copy link
Member

@Blendify Blendify commented Apr 6, 2021

The latest theme version is compatible with all sphinx versions.
This should fix #8070

In the future, we will want to modify the version number used for old sphinx versions once sphinx 1.x is dropped by the theme.
This likely won't happen until sphinx-rtd-theme 2.0 see readthedocs/sphinx_rtd_theme#1086

I haven't tested this yet, but in the future, this may not be needed at all as we can handle dependency versions within the theme itself.

Blendify added 2 commits April 6, 2021 19:26
The latest theme version is compatible with all sphinx versions.
This should fix readthedocs#8070

In the future, we will want to modify the version number used for old sphinx versions once sphinx 1.x is dropped by the theme.
This likely won't happen until `sphinx-rtd-theme 2.0` see readthedocs/sphinx_rtd_theme#1086

I haven't tested this yet, but in the future, this may not be needed at all as we can handle dependency versions within the theme itself.
@stsewd
Copy link
Member

stsewd commented Apr 6, 2021

New projects (projects created after Oct 20, 2020 ) use the latest version of sphinx and the rtd theme by default. This change will update the theme from 0.4.x to 0.5.x in projects created before oct 20, which may break some things. In the future we may stop installing the theme by default so users woul need to provide their requirements explicitily (#7859). I think is better if users update the theme explicitly or pin docutils to 0.16 explicitly https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html#don-t-rely-on-implicit-dependencies to fix this problem, otherwise upgrading may break things for some users.

@Blendify
Copy link
Member Author

Blendify commented Apr 7, 2021

This change will update the theme from 0.4.x to 0.5.x in projects created before oct 20, which may break some things.

There shouldn't be any changes in updating the theme for these old projects. I looked over the changelog to make sure https://sphinx-rtd-theme.readthedocs.io/en/latest/changelog.html

@stsewd
Copy link
Member

stsewd commented Apr 7, 2021

There shouldn't be any changes in updating the theme for these old projects. I looked over the changelog to make sure

I wasn't close to the 0.4 to 0.5 release, but if there isn't anything breaking I'm fine updating.

@stale
Copy link

stale bot commented Jun 2, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Jun 2, 2021
@stale stale bot closed this Jun 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: stale Issue will be considered inactive soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Toctree error
2 participants