Skip to content

Add support for Sphinx 9.0.0 #1666

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add support for Sphinx 9.0.0 #1666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2300ac9
Initial plan
Copilot Dec 1, 2025
2dfc9f1
Add support for Sphinx 9.0.0
Copilot Dec 1, 2025
635a9f8
Update docs
humitos Dec 1, 2025
76a42cb
Use Sphinx 9.x for documentation
humitos Dec 1, 2025
9f6556b
Added changelog entry and bumped version to 3.1.0rc1
humitos Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,23 +71,23 @@ jobs:
steps:
- run-tox:
version: py311
sphinx-version: "72,73,74,80,81,82,latest,dev"
sphinx-version: "72,73,74,80,81,82,90,latest,dev"

py312:
docker:
- image: 'cimg/python:3.12'
steps:
- run-tox:
version: py312
sphinx-version: "72,73,74,80,81,82,latest,dev"
sphinx-version: "72,73,74,80,81,82,90,latest,dev"

py313:
docker:
- image: 'cimg/python:3.13'
steps:
- run-tox:
version: py313
sphinx-version: "72,73,74,80,81,82,latest,dev"
sphinx-version: "72,73,74,80,81,82,90,latest,dev"

workflows:
version: 2
Expand Down
10 changes: 9 additions & 1 deletion docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ Changelog

.. seealso:: :ref:`howto_upgrade`

.. |theme_version| replace:: 3.0.2
.. |theme_version| replace:: 3.1.0rc1

.. _release-3.1.0rc1:

3.1.0rc1
========

* Added support for Sphinx 9.


.. _release-3.0.2:

Expand Down
10 changes: 10 additions & 0 deletions docs/development.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ The theme officially supports the following dependencies in your Sphinx project:
* - docutils
- > 0.18, < 0.22

.. versionadded:: 3.1
Sphinx 9.0 support added

.. deprecated:: 3.0
Sphinx < 6 support removed

Expand Down Expand Up @@ -191,6 +194,13 @@ Internet Explorer 11 support will be dropped
so we are not supporting it on newer versions,
starting on 3.0.0.

3.1.0
Copy link
Collaborator

@agjohnson agjohnson Dec 3, 2025

Choose a reason for hiding this comment

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

This is not the right place to document the version. This document is describing major development releases, not minor releases. We've been updating the changelog page with versions and future versions/RCs.

Copy link
Collaborator

@agjohnson agjohnson Dec 3, 2025

Choose a reason for hiding this comment

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

Also, I feel we should bump the version to an RC so users installing this package via Git have the latest RC at hand. We don't need to release to PyPI yet, but that's the next step

Copy link
Member

@humitos humitos Dec 3, 2025

Choose a reason for hiding this comment

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

This is not the right place to document the version. This document is describing major development releases, not minor releases.

We have 1.1.0 in the section. That's why I added it here.

https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#roadmap-release-1-1-0

Copy link
Member

@humitos humitos Dec 3, 2025

Choose a reason for hiding this comment

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

Also, I feel we should bump the version to an RC so users installing this package via Git have the latest RC at hand. We don't need to release to PyPI yet, but that's the next step

OK. I pushed 9f6556b with changelog and rc version.

~~~~~

:Planned release date: 2025 Q4

This release adds support for Sphinx 9.0.

.. _roadmap-release-4.0.0:

4.0.0
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
sphinx~=8.0
sphinx~=9.0
2 changes: 1 addition & 1 deletion setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ zip_safe = False
packages = sphinx_rtd_theme
python_requires = >=3.8
install_requires =
sphinx >=6,<9
sphinx >=6,<10
docutils >0.18,<0.22
sphinxcontrib-jquery >=4,<5
tests_require =
Expand Down
2 changes: 1 addition & 1 deletion sphinx_rtd_theme/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from sphinx.util.logging import getLogger


__version__ = '3.0.2'
__version__ = '3.1.0rc1'
__version_full__ = __version__

logger = getLogger(__name__)
Expand Down
3 changes: 2 additions & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
envlist =
py{38,39,310}-sphinx{60,61,62,70,71}{-qa}
py{39,310,311,312,313}-sphinx{72,73,74,80}{-qa}
py{311,312,313}-sphinx{81,82,latest,dev}{-qa}
py{311,312,313}-sphinx{81,82,90,latest,dev}{-qa}

[testenv]
setenv =
Expand All @@ -19,6 +19,7 @@ deps =
sphinx80: Sphinx>=8.0,<8.1
sphinx81: Sphinx>=8.1,<8.2
sphinx82: Sphinx>=8.2,<8.3
sphinx90: Sphinx>=9.0,<9.1
sphinxlatest: Sphinx
sphinxdev: https://github.com/sphinx-doc/sphinx/archive/refs/heads/master.zip
allowlist_externals =
Expand Down