ORNL / ORNL/intersect-architecture

RTD build failures

Open
#33 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
XSLT
Stars
6
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Looks like there are build failures due to the mermaid pkg with more recent version of Sphinx. Adding this issue to track this item.
It appears if we limit sphinx>=4.2.0,<8.0.0 it works ok.

Output from ReadTheDocs build (example):

python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Running Sphinx v8.1.0
loading translations [en]... done
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/intersect-architecture/envs/31/lib/python3.12/site-packages/sphinx/registry.py", line 453, in load_extension
    mod = import_module(extname)
          ^^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/.asdf/installs/python/3.12.3/lib/python3.12/importlib/__init__.py", line 90, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1387, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1360, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 995, in exec_module
  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed
  File "/home/docs/checkouts/readthedocs.org/user_builds/intersect-architecture/envs/31/lib/python3.12/site-packages/sphinxcontrib/mermaid.py", line 33, in <module>
    from .autoclassdiag import class_diagram
  File "/home/docs/checkouts/readthedocs.org/user_builds/intersect-architecture/envs/31/lib/python3.12/site-packages/sphinxcontrib/autoclassdiag.py", line 3, in <module>
    from sphinx.util import ExtensionError, import_object
ImportError: cannot import name 'ExtensionError' from 'sphinx.util' (/home/docs/checkouts/readthedocs.org/user_builds/intersect-architecture/envs/31/lib/python3.12/site-packages/sphinx/util/__init__.py)
The above exception was the direct cause of the following exception:
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/intersect-architecture/envs/31/lib/python3.12/site-packages/sphinx/cmd/build.py", line 496, in build_main
    app = Sphinx(
          ^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/intersect-architecture/envs/31/lib/python3.12/site-packages/sphinx/application.py", line 256, in __init__
    self.setup_extension(extension)
  File "/home/docs/checkouts/readthedocs.org/user_builds/intersect-architecture/envs/31/lib/python3.12/site-packages/sphinx/application.py", line 437, in setup_extension
    self.registry.load_extension(self, extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/intersect-architecture/envs/31/lib/python3.12/site-packages/sphinx/registry.py", line 456, in load_extension
    raise ExtensionError(__('Could not import extension %s') % extname,
sphinx.errors.ExtensionError: Could not import extension sphinxcontrib.mermaid (exception: cannot import name 'ExtensionError' from 'sphinx.util' (/home/docs/checkouts/readthedocs.org/user_builds/intersect-architecture/envs/31/lib/python3.12/site-packages/sphinx/util/__init__.py))
Extension error:
Could not import extension sphinxcontrib.mermaid (exception: cannot import name 'ExtensionError' from 'sphinx.util' (/home/docs/checkouts/readthedocs.org/user_builds/intersect-architecture/envs/31/lib/python3.12/site-packages/sphinx/util/__init__.py))

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the ReadTheDocs build with the current Sphinx and sphinxcontrib.mermaid versions, then locate the documentation dependency configuration. Verify that the chosen Sphinx constraint avoids the reported ExtensionError and that the documentation build completes successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.