Cannot run with Sphinx 8.2.0

[arafune]

sphinx-doc/sphinx#13352, sphinx-doc/sphinx#13364

[byrdie]

I'm experiencing the same problem.

[kaushikcfd]

Same.

I guess we need an import statement in nbsphinx/__init__.py.

$ python
Python 3.13.2 | packaged by conda-forge | (main, Feb 17 2025, 14:10:22) [GCC 13.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import sphinx
>>> sphinx.__version__
'8.2.0'
>>> sphinx.util.console
Traceback (most recent call last):
  File "<python-input-2>", line 1, in <module>
    sphinx.util.console
  File "/home/kaushikggg/.mambaforge/envs/py312_env/lib/python3.13/site-packages/sphinx/util/__init__.py", line 157, in __getattr__
    raise AttributeError(msg)
AttributeError: module 'sphinx.util' has no attribute 'console'
>>> import sphinx.util.console
>>> sphinx.util.console.brown
<function _create_colour_func.<locals>.inner at 0x7f787098c220>

[josephburkhart]

I am having the same issue, noticed it when I was testing a build on readthedocs today.

The full traceback:

Traceback (most recent call last):
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/sphinx/events.py", line 404, in emit
        results.append(listener.handler(self.app, *args))
                       ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/nbsphinx/__init__.py", line 1714, in html_collect_pages
        sphinx.util.console.brown, len(files)):
        ^^^^^^^^^^^^^^^^^^^
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/sphinx/util/__init__.py", line 157, in __getattr__
        raise AttributeError(msg)
    AttributeError: module 'sphinx.util' has no attribute 'console'
    
    The above exception was the direct cause of the following exception:
    
    Traceback (most recent call last):
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/sphinx/cmd/build.py", line 432, in build_main
        app.build(args.force_all, args.filenames)
        ~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/sphinx/application.py", line 426, in build
        self.builder.build_update()
        ~~~~~~~~~~~~~~~~~~~~~~~~~^^
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/sphinx/builders/__init__.py", line 375, in build_update
        self.build(
        ~~~~~~~~~~^
            to_build,
            ^^^^^^^^^
        ...<2 lines>...
            method='update',
            ^^^^^^^^^^^^^^^^
        )
        ^
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/sphinx/builders/__init__.py", line 457, in build
        self.finish()
        ~~~~~~~~~~~^^
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/sphinx/builders/html/__init__.py", line 688, in finish
        self.finish_tasks.add_task(self.gen_pages_from_extensions)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/sphinx/util/parallel.py", line 46, in add_task
        res = task_func()  # type: ignore[call-arg]
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/sphinx/builders/html/__init__.py", line 707, in gen_pages_from_extensions
        for pagelist in self.events.emit('html-collect-pages'):
                        ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^
      File "/home/docs/checkouts/readthedocs.org/user_builds/coxeter/conda/252/lib/python3.13/site-packages/sphinx/events.py", line 415, in emit
        raise ExtensionError(
        ...<4 lines>...
        ) from exc
    sphinx.errors.ExtensionError: Handler <function html_collect_pages at 0x7f610a4a2ac0> for event 'html-collect-pages' threw an exception (exception: module 'sphinx.util' has no attribute 'console')

Contents of my `.readthedocs.yml`:

version: 2
build:
  os: ubuntu-22.04
  tools:
    python: "mambaforge-4.10"
  jobs:
    pre_build:
      - echo "Copying static X3D files..."; mkdir -p $READTHEDOCS_OUTPUT/html/_static/x3d; cp -r ./doc/source/_static/x3d $READTHEDOCS_OUTPUT/html/_static
formats:
    - htmlzip
conda:
    environment: doc/environment.yml
python:
    install:
        - method: pip
          path: .
sphinx:
    configuration: doc/source/conf.py

Contents of my `environment.yml`:

channels:
- conda-forge
- defaults
dependencies:
- numpy
- pandas
- rowan>=1.2
- scipy
- jupyter
- sphinx
- furo>=2023.9.10
- sphinxcontrib-bibtex>=2.0.0
- autodocsumm
- nbsphinx>=0.9.6
- fresnel
- matplotlib
- pip:
  - plato-draw
- sphinx
name: coxeter-readthedocs

What fixed the issue was pinning the version of sphinx to 8.1.3 in environment.yml.

[mgeier]

There seem to be multiple issues, also involving 3rd party modules. For now, I'm planning to not support Sphinx 8.2 right now: #828.

[AA-Turner]

Sphinx 8.2.2 includes a temporary work-around for this issue, but the correct fix is to use explicit imports rather than implicit. Sorry that it took a few days, the approach to solve the regression only occured to me recently.

A

[AA-Turner]

There seem to be multiple issues, also involving 3rd party modules.

Please report any remaining/outstanding regressions to Sphinx, as I've tried to fix all the ones I have seen so far.

[mgeier]

Thanks @AA-Turner for the work-around!

the correct fix is to use explicit imports rather than implicit.

Yeah, this will happen in #827. This is the easiest of all the recent problems.

Please report any remaining/outstanding regressions to Sphinx

I think there are no more unreported issues left.

Currently, there is still a warning from felix-hilden/sphinx-codeautolink#173 and the problem reported in sphinx-doc/sphinx#13346 (with your partial fix #822) is still waiting to be resolved.

[jenshnielsen]

@mgeier note that in addition to the issue in sphinx-codeautolink there is also missinglinkelectronics/sphinxcontrib-svg2pdfconverter#26 which is triggered by nbsphinx ci. See old comments in #826 The fix is simple and I have submitted a pr for that missinglinkelectronics/sphinxcontrib-svg2pdfconverter#27

Both the issues in sphinxcontrib-svg2pdfconverter and sphinx-codeautolink however don't really prevent using nbsphinx with sphinx 8.2 since none of them are requirements of nbsphinx