Skip to content
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

Add Sphinx 7 support #1463

Closed
MehdiChinoune opened this issue Apr 30, 2023 · 15 comments · Fixed by #1464
Closed

Add Sphinx 7 support #1463

MehdiChinoune opened this issue Apr 30, 2023 · 15 comments · Fixed by #1464
Assignees
Labels
Bug A bug Needed: replication Bug replication is required

Comments

@MehdiChinoune
Copy link

Problem

Support sphinx>=7

@MehdiChinoune MehdiChinoune added Bug A bug Needed: replication Bug replication is required labels Apr 30, 2023
@benjaoming benjaoming mentioned this issue Apr 30, 2023
1 task
@benjaoming benjaoming changed the title sphinx 7 Add Sphinx 7 support May 3, 2023
rjgildea added a commit to DiamondLightSource/ispyb-api that referenced this issue May 15, 2023
rjgildea added a commit to DiamondLightSource/ispyb-api that referenced this issue May 15, 2023
@Paebbels
Copy link

Paebbels commented May 23, 2023

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.

@benjaoming
Copy link
Contributor

@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.

@Paebbels
Copy link

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.

@benjaoming
Copy link
Contributor

@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 👍

@dyve
Copy link

dyve commented May 24, 2023

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

@agjohnson
Copy link
Collaborator

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.

@potiuk
Copy link

potiuk commented Aug 8, 2023

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" 😄

@jooola
Copy link

jooola commented Aug 9, 2023

We started a preview with the release candidate and sphinx 7. Everything is looking good on our side!

hetznercloud/hcloud-python#211
https://hcloud-python--211.org.readthedocs.build/en/211/

psss added a commit to teemtee/tmt that referenced this issue Aug 9, 2023
Currently docs building is broken because of
readthedocs/sphinx_rtd_theme#1463.
Let's use the latest available to fix docs building now.
DRuffer-tmo pushed a commit to tmobile/DevEdge-IoTDevKit-ZephyrRTOS that referenced this issue Aug 9, 2023
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 <gerard.marull@nordicsemi.no>
matthewfeickert added a commit to scikit-hep/pyhf that referenced this issue Aug 10, 2023
* 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.
tpike3 pushed a commit to projectmesa/mesa that referenced this issue Aug 10, 2023
matthewfeickert added a commit to scikit-hep/pyhf that referenced this issue Aug 16, 2023
* 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.
humitos added a commit that referenced this issue Aug 17, 2023
Sphinx 7.2 changed its internal API for `toctree()`.

See sphinx-doc/sphinx#11607
Related #1463
This was referenced Aug 24, 2023
fviernau added a commit to fviernau/python-inspector that referenced this issue Sep 25, 2023
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 <frank_viernau@epam.com>
fviernau added a commit to fviernau/python-inspector that referenced this issue Sep 25, 2023
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 <frank_viernau@epam.com>
leocardao added a commit to leocardao/e3-core that referenced this issue Oct 4, 2023
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.
leocardao added a commit to leocardao/e3-core that referenced this issue Oct 4, 2023
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.
leocardao added a commit to leocardao/e3-core that referenced this issue Oct 4, 2023
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug Needed: replication Bug replication is required
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.