Broken on Sphinx 7.2.0 #219

hynek · 2023-08-17T04:19:24Z

docs: commands[0]> sphinx-build -n -T -W -b html -d /Users/hynek/FOSS/svcs/.tox/docs/tmp/doctrees docs docs/_build/html
Running Sphinx v7.2.0

Traceback (most recent call last):
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphinx/cmd/build.py", line 293, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphinx/application.py", line 232, in __init__
    self.setup_extension(extension)
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphinx/application.py", line 405, in setup_extension
    self.registry.load_extension(self, extname)
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphinx/registry.py", line 460, in load_extension
    metadata = setup(app)
               ^^^^^^^^^^
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/notfound/extension.py", line 337, in setup
    from sphinx.builders.html import setup_js_tag_helper
ImportError: cannot import name 'setup_js_tag_helper' from 'sphinx.builders.html' (/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphinx/builders/html/__init__.py)

Exception occurred:
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/notfound/extension.py", line 337, in setup
    from sphinx.builders.html import setup_js_tag_helper
ImportError: cannot import name 'setup_js_tag_helper' from 'sphinx.builders.html' (/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphinx/builders/html/__init__.py)
The full traceback has been saved in /var/folders/8c/ffnfsd7s3y151ptr05s8v3tw0000gn/T/sphinx-err-_fb_typ5.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!

Full traceback referenced in log:

# Platform:         darwin; (macOS-13.5-arm64-arm-64bit)
# Sphinx version:   7.2.0
# Python version:   3.11.4 (CPython)
# Docutils version: 0.20.1
# Jinja2 version:   3.1.2
# Pygments version: 2.16.1

# Last messages:


# Loaded extensions:


# Traceback:
Traceback (most recent call last):
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphinx/cmd/build.py", line 293, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphinx/application.py", line 232, in __init__
    self.setup_extension(extension)
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphinx/application.py", line 405, in setup_extension
    self.registry.load_extension(self, extname)
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphinx/registry.py", line 460, in load_extension
    metadata = setup(app)
               ^^^^^^^^^^
  File "/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/notfound/extension.py", line 337, in setup
    from sphinx.builders.html import setup_js_tag_helper
ImportError: cannot import name 'setup_js_tag_helper' from 'sphinx.builders.html' (/Users/hynek/FOSS/svcs/.tox/docs/lib/python3.11/site-packages/sphi
nx/builders/html/__init__.py)

The text was updated successfully, but these errors were encountered:

humitos · 2023-08-17T12:54:27Z

The helper was removed in Sphinx 7.2.0 at sphinx-doc/sphinx@4b082f7db. We will need to use the new API for CSS and JS here. See sphinx-doc/sphinx#11608

Seems the latest Sphinx update has caused more issues ... 7.2.2 doesn't work with the notfound extension (see readthedocs/sphinx-notfound-page#219 ). When restricting Sphinx to <7.2.0, RTD uses 6.2.1 though, which is incompatible with a Furo change (see pradyunsg/furo#693 ). Therefore, restrict Sphinx to 7.1.2 until the issues are resolved. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>

Seems the latest Sphinx update has caused some issues ... 7.2.2 doesn't work with the notfound extension (see readthedocs/sphinx-notfound-page#219 ). When restricting Sphinx to <7.2.0, RTD uses 6.2.1 though, which is incompatible with a Furo change (see pradyunsg/furo#693 ). Therefore, restrict Sphinx to 7.1.2 until the issues are resolved. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>

Seems the latest Sphinx update has caused more issues ... 7.2.2 doesn't work with the notfound extension (see readthedocs/sphinx-notfound-page#219 ). When restricting Sphinx to <7.2.0, RTD uses 6.2.1 though, which is incompatible with a Furo change (see pradyunsg/furo#693 ). Therefore, restrict Sphinx to 7.1.2 until the issues are resolved. Signed-off-by: Ruth Fuchss <ruth.fuchss@canonical.com>

humitos · 2023-08-24T14:07:22Z

I released https://pypi.org/project/sphinx-notfound-page/1.0.0rc1/, please give it a try and let me know if it works fine for your use case.

hugovk · 2023-08-24T14:13:50Z

Works locally with python/devguide#1155 with requirements.txt:

-sphinx-notfound-page
+sphinx-notfound-page==1.0.0rc1

Thanks!

ru-fu · 2023-08-24T14:45:53Z

Works fine here as well - thanks for the quick fix!

humitos · 2023-08-24T14:50:04Z

I plan to wait a couple of days before releasing the final 1.0.0 -- I think I will do it next Wednesday.

return42 · 2023-08-27T13:35:38Z

Not sure if it is related, but I got an error::

Theme error:
An error happened in rendering the page 404.
Reason: ValueError("invalid literal for int() with base 10: ''")

.. I'm still in analysis

- Sphinx-doc 7.2.0 drops py3.8 support [1][2] - last version with py3.8 support is 7.1.2 Many LTS distributions still have py3.8 which EOL is in 2024-10 [3]. To continue to support a development environment on py3.8 the rigid dependency in the development environment is unpinned in py3.8 / environment markers [4]. To get 7.2.3. work, a fix in sphinx-notfound-page is needed. [1] searxng#2658 (comment) [2] sphinx-doc/sphinx#11621 [3] https://devguide.python.org/versions/#supported-versions [4] https://peps.python.org/pep-0508/#environment-markers [5] readthedocs/sphinx-notfound-page#219 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

return42 · 2023-08-27T15:05:25Z

FWI: in the theme.conf I had to set globaltoc_maxdepth to an integer ..

[options]
globaltoc_maxdepth = 5

it seems the default is an empty string ...

  File "site-packages/sphinx/themes/basic/../basic/layout.html", line 60, in template
    {%- include sidebartemplate %}
  File "site-packages/sphinx/themes/basic/globaltoc.html", line 11, in top-level template code
    {{ toctree(includehidden=theme_globaltoc_includehidden, collapse=theme_globaltoc_collapse, maxdepth=theme_globaltoc_maxdepth) }}
  File "site-packages/jinja2/sandbox.py", line 393, in call
    return __context.call(__obj, *args, **kwargs)
  File "site-packages/notfound/extension.py", line 128, in toctree
    toc = global_toctree_for_doc(
  File "sphinx/environment/adapters/toctree.py", line 86, in global_toctree_for_doc
    maxdepth=int(maxdepth),
ValueError: invalid literal for int() with base 10: ''

There was a similar issue in the past:

Cast maxdepth to int in toctree sphinx-doc/sphinx#8665

I assume the issue has been back by:

Refactor sphinx.environment.adapters.TocTree sphinx-doc/sphinx#11565

- Sphinx-doc 7.2.0 drops py3.8 support [1][2] - last version with py3.8 support is 7.1.2 Many LTS distributions still have py3.8 which EOL is in 2024-10 [3]. To continue to support a development environment on py3.8 the rigid dependency in the development environment is unpinned in py3.8 / environment markers [4]. To get 7.2.3. work, a fix in sphinx-notfound-page is needed [5][6]. [1] searxng#2658 (comment) [2] sphinx-doc/sphinx#11621 [3] https://devguide.python.org/versions/#supported-versions [4] https://peps.python.org/pep-0508/#environment-markers [5] readthedocs/sphinx-notfound-page#219 [6] readthedocs/sphinx-notfound-page#219 (comment) Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

- Sphinx-doc 7.2.0 drops py3.8 support [1][2] - last version with py3.8 support is 7.1.2 Many LTS distributions still have py3.8 which EOL is in 2024-10 [3]. To continue to support a development environment on py3.8 the rigid dependency in the development environment is unpinned in py3.8 / environment markers [4]. To get 7.2.3. work, a fix in sphinx-notfound-page is needed [5][6]. [1] #2658 (comment) [2] sphinx-doc/sphinx#11621 [3] https://devguide.python.org/versions/#supported-versions [4] https://peps.python.org/pep-0508/#environment-markers [5] readthedocs/sphinx-notfound-page#219 [6] readthedocs/sphinx-notfound-page#219 (comment) Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

humitos · 2023-08-27T18:40:43Z

@return42 I opened #221 to track the issue you are reporting more in deep.

humitos · 2023-08-30T11:34:47Z

I released v1.0.0. I hope it works for everybody 🙏🏼

hynek · 2023-08-30T12:23:16Z

Can confirm – thanks for fixing!

return42 · 2023-08-30T12:33:07Z

Works 👍 .. thanks a lot for fixing! Not sure, may you also want to close ...?

globaltoc_maxdepth fails on its default value #221

Bump sphinx-notfound-page from 1.0.0rc1 to 1.0.0 searxng/searxng#2696

humitos · 2023-08-30T13:23:33Z

Not sure, may you also want to close ...?

I think we can close it because I understand it's an upstream issue, yeah 👍🏼

humitos added Improvement Minor improvement to code Accepted Accepted issue on our roadmap labels Aug 17, 2023

larsoner mentioned this issue Aug 17, 2023

Bump sphinx from 7.1.2 to 7.2.1 pyvista/pyvistaqt#457

Merged

abravalheri mentioned this issue Aug 17, 2023

Fix editable install finder handling of nested packages pypa/setuptools#4020

Merged

2 tasks

Revathyvenugopal162 mentioned this issue Aug 18, 2023

Build(deps-dev): Bump sphinx from 7.1.2 to 7.2.2 ansys/ansys-sphinx-theme#277

Closed

Revathyvenugopal162 mentioned this issue Aug 21, 2023

Bump sphinx from 7.1.2 to 7.2.2 ansys/pymechanical#358

Merged

pmatulis mentioned this issue Aug 21, 2023

Pin Sphinx version temporarily canonical/hpc-docs#8

Merged

ru-fu mentioned this issue Aug 21, 2023

Pin sphinx version canonical/sphinx-docs-starter-pack#76

Merged

namurphy mentioned this issue Aug 22, 2023

Unpin version of Sphinx after next release of sphinx-notfound-page PlasmaPy/PlasmaPy#2298

Closed

humitos mentioned this issue Aug 22, 2023

Getting Error on import to setup_js_tag_helper sphinx-doc/sphinx#11633

Closed

oraNod mentioned this issue Aug 23, 2023

Docs builds are failing with sphinx v7 ansible/ansible-documentation#327

Closed

This was referenced Aug 23, 2023

Bump sphinx from 7.1.1 to 7.2.2 in /documentation WordPress/openverse#2871

Closed

Bump sphinx from 7.1.1 to 7.2.3 in /documentation WordPress/openverse#2877

Closed

hugovk mentioned this issue Aug 24, 2023

Bump Sphinx to 7.2.5 python/devguide#1155

Merged

This was referenced Aug 24, 2023

Add instructions for publishing new releases brainglobe/brainglobe.github.io#52

Merged

Update Sphinx version. brainglobe/brainglobe.github.io#53

Closed

humitos mentioned this issue Aug 24, 2023

Drop support for Sphinx<5 #220

Merged

humitos closed this as completed in #220 Aug 24, 2023

return42 mentioned this issue Aug 27, 2023

[dev-env] upgrade Sphinx-doc 7.2.3 and unpin at v7.1.2 on py3.8 searxng/searxng#2683

Merged

humitos mentioned this issue Aug 27, 2023

globaltoc_maxdepth fails on its default value #221

Closed

NicerNewerCar mentioned this issue Aug 28, 2023

Fix errors with RTD build BrownBiomechanics/Autoscoper#200

Merged

MatthewFlamm mentioned this issue Aug 29, 2023

Bump sphinx from 7.1.2 to 7.2.4 pyvista/pytest-pyvista#69

Closed

ganto mentioned this issue Nov 11, 2023

Sphinx 7.x: ImportError: cannot import name 'setup_js_tag_helper' ganto/copr-lxc4#31

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Broken on Sphinx 7.2.0 #219

Broken on Sphinx 7.2.0 #219

hynek commented Aug 17, 2023

humitos commented Aug 17, 2023

humitos commented Aug 24, 2023

hugovk commented Aug 24, 2023 •

edited

ru-fu commented Aug 24, 2023

humitos commented Aug 24, 2023

return42 commented Aug 27, 2023 •

edited

return42 commented Aug 27, 2023 •

edited

humitos commented Aug 27, 2023

humitos commented Aug 30, 2023

hynek commented Aug 30, 2023

return42 commented Aug 30, 2023

humitos commented Aug 30, 2023

Broken on Sphinx 7.2.0 #219

Broken on Sphinx 7.2.0 #219

Comments

hynek commented Aug 17, 2023

humitos commented Aug 17, 2023

humitos commented Aug 24, 2023

hugovk commented Aug 24, 2023 • edited

ru-fu commented Aug 24, 2023

humitos commented Aug 24, 2023

return42 commented Aug 27, 2023 • edited

return42 commented Aug 27, 2023 • edited

humitos commented Aug 27, 2023

humitos commented Aug 30, 2023

hynek commented Aug 30, 2023

return42 commented Aug 30, 2023

humitos commented Aug 30, 2023

hugovk commented Aug 24, 2023 •

edited

return42 commented Aug 27, 2023 •

edited

return42 commented Aug 27, 2023 •

edited