Support Sphinx 8

[jwodder]

Sphinx 8 was released on July 29, yet sphinx-rtd-theme requires a Sphinx version less than 8. Please add support for Sphinx 8.

[dylanh724]

High priority, imo!

[stephanebruckert]

This is the error we are getting https://readthedocs.org/projects/spotipy/builds/25216396/

The conflict is caused by:
    The user requested Sphinx~=8.0.2
    sphinx-rtd-theme 2.0.0 depends on sphinx<8 and >=5

[dylanh724]

Possibly relevant:

• Support Sphinx v8 executablebooks/MyST-Parser#950

[ericholscher]

We're hoping to get a 3.0 release out with support for Sphinx 8 soon. There's an open PR here: #1576 -- if you want to try and install from that branch and ensure things look & work well, that would be helpful to us getting it out officially, as testing is the biggest step before a release.

[Mr0grog]

if you want to try and install from that branch and ensure things look & work well, that would be helpful

Tried this out on a project I maintain (wayback), and it seems to work great!

Built the docs with dependencies in pyproject.toml:

[project.optional-dependencies]
docs = [
    "sphinx ~=8.0.2",
    "sphinx_rtd_theme @ git+https://github.com/readthedocs/sphinx_rtd_theme.git@humitos/plan-3.0",

    # Probably not relevant, but these were also in use:
    "ipython ~=8.16.1",
    "numpydoc ~=1.6.0",
    "sphinx-copybutton ~=0.5.2",
]

Installation resolved correct versions without warnings or errors, Sphinx docs build had no errors, and output looks OK at a quick glance.

(Update: forgot to mention this was on Python 3.10, 3.11, 3.12.1, and 3.13.0rc1)

[humitos]

We released a new version 3.0.0rc1 that adds support for latest Sphinx versions. Please, give it a try and open an issue for any problem or feedback you want to share with us.

[dylanh724]

@humitos I really appreciate you remembering me for this! I ended up moving to PyData's Book theme -- that 3rd column was too important to me. However, I do still appreciate this theme like crazy (and use RTD as the host) <3

[Segelzwerg]

We released a new version 3.0.0rc1 that adds support for latest Sphinx versions. Please, give it a try and open an issue for any problem or feedback you want to share with us.

I can confirm that my build worked with 3.0.0rc1 and sphinx 8.0.2.
Segelzwerg/django-dynamic-theme#163