RTD build failures

Aperta
#33 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python

Direzione di ricerca

Inizia riproducendo la build di ReadTheDocs con le versioni correnti di Sphinx e sphinxcontrib.mermaid, quindi individua la configurazione delle dipendenze della documentazione. Verifica che il vincolo Sphinx scelto eviti l’ExtensionError segnalato e che la build della documentazione venga completata correttamente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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))
Lingua principale
XSLT
Stelle
8
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ORNL/intersect-architecture

Tutte le issue di ORNL/intersect-architecture

Issue simili

Altre issue su Build System

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.