Add Sphinx 7 support #1463
Comments
|
Besides missing Sphinx 7 support, also Sphinx 6.1 isn't supported. This theme is still months behind the development of Sphinx and docutils. This is related to:
Many documentation sites are currently switching to furo, because of better theme maintenance and better feature set. |
|
@Paebbels docutils 0.18 is supported and Sphinx 6.1 is also supported. But agreed, there's also lack of maintenance for sphinx-rtd-theme. But the main reason is that the theme still hasn't reached the 2.0 roadmap milestone where a bunch of tedious legacy support is removed. |
|
Hmmm, I get lots of errors when switching to Sphinx 6.1. I'll try to investigate, but debugging Sphinx is a mess as it has no good error messages and no (good) exception handling. |
|
@Paebbels you can open an issue about Sphinx 6.1 support, sharing the error messages, and we can see if it's a real issue or not 👍 |
ERROR: Cannot install -r docs/requirements.txt (line 2) and sphinx==7.0.1 because these package versions have conflicting dependencies.
The conflict is caused by:
The user requested sphinx==7.0.1
sphinx-rtd-theme 1.2.1 depends on sphinx<7 and >=1.6
To fix this you could try to:
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict |
|
We'll probably give this a little more time to simmer and receive some more feedback. But I suspect we won't hit any major blocking issues besides issues around lack of docutils 0.19+ support. Perhaps later this week or next Tues we can aim for the full release. |
Cool. That would be great. We have some high hopes because there seem to be improvements (apparently - looking at Github Issues) that Sphinx 7 has when it comes to error messages. We have rather extensive documentation coming from various sources (docstring/rst files/jinja pre-processed .rst files and so on) and it's often trial-and-error for some of the changes from our users to figure out what's wrong with their docs (especially about empty lines and indentations). Apparently Sphinx 7 has at least some of it improved. I remember loosing hours on trying to bi-sect the change and narrow it down to some parts to see which one caused problems with Sphinx we were limited to. I even kept on saying to our contributtors " Well It's a known fact that Sphinxes speak riddles - you just need to figure it out" 😄 |
|
We started a preview with the release candidate and sphinx 7. Everything is looking good on our side! hetznercloud/hcloud-python#211 |
Currently docs building is broken because of readthedocs/sphinx_rtd_theme#1463. Let's use the latest available to fix docs building now.
Update Sphinx and docleaf. Note that Sphinx 7 is not an option because rtd_theme requires <= 6 (see readthedocs/sphinx_rtd_theme#1463). Signed-off-by: Gerard Marull-Paretas <[email protected]>
* Update lower bound on sphinx-rtd-theme to v1.3.0rc1 to ensure compatibility with Sphinx v7+. - c.f. readthedocs/sphinx_rtd_theme#1463 - As soon as sphinx-rtd-theme v1.3.0 is released on PyPI the lower bound should be updated to reflect this stable release. The release candidate is being used to unbreak CI. * Update lower bound of Sphinx to v7.0.0 for consistency.
This is because readthedocs/sphinx_rtd_theme#1463 has been resolved.
* Update lower bound on sphinx-rtd-theme to v1.3.0rc1 to ensure compatibility with Sphinx v7+. - c.f. readthedocs/sphinx_rtd_theme#1463 - As soon as sphinx-rtd-theme v1.3.0 is released on PyPI the lower bound should be updated to reflect this stable release. The release candidate is being used to unbreak CI. * Update lower bound of Sphinx to v7.0.0 for consistency.
Sphinx 7.2 changed its internal API for `toctree()`. See sphinx-doc/sphinx#11607 Related #1463
The support for `Sphinx` version 7 has been implemented in `rdt-themes`, but hasn't yet been released [1]. Currently, the build uses `Sphinx` version 7 which fails with [2]. Use a `Sphinx` version prior to 7 in order to fix that issue. [1] readthedocs/sphinx_rtd_theme#1463 [2] `UndefinedError("'style' is undefined")` Signed-off-by: Frank Viernau <[email protected]>
The support for `Sphinx` version 7 has been implemented in `rdt-themes`, but hasn't yet been released [1]. Currently, the build uses `Sphinx` version 7 which fails with [2]. Use a `Sphinx` version prior to 7 in order to fix that issue. [1] readthedocs/sphinx_rtd_theme#1463 [2] `UndefinedError("'style' is undefined")` Signed-off-by: Frank Viernau <[email protected]>
Last time, the doc build failed because rtd was not fully supported by
Sphinx7.
See:
- readthedocs/sphinx_rtd_theme#1463
- aboutcode-org/python-inspector#146
This problem has now been corrected, so we want to use the latest
rtd-compatible version of Sphinx.
Also fix the requirements version used in order to avoid future build
failure.
Last time, the doc build failed because rtd was not fully supported by Sphinx7. (See: readthedocs/sphinx_rtd_theme#1463) This problem has now been corrected, so we want to use the latest rtd-compatible version of Sphinx. Also fix the requirements version used in order to avoid future build failure.
Last time, the doc build failed because rtd was not fully supported by Sphinx7. (See: readthedocs/sphinx_rtd_theme#1463) This problem has now been corrected, so we want to use the latest rtd-compatible version of Sphinx. Also fix the requirements version used in order to avoid future build failure.
Problem
Support sphinx>=7
The text was updated successfully, but these errors were encountered: