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

Could not import extension sphinxcontrib.mermaid (exception: cannot import name 'ExtensionError' from 'sphinx.util' ... #5954

Open
IHMEkaleb opened this issue Oct 10, 2024 · 3 comments
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect

Comments

@IHMEkaleb
Copy link

Description

When I run sphinx-build with sphinxcontrib.mermaid 0.9.2 and sphinx 8.1.0, I get this error:

sphinx-build /path/to/docs /path/for/build/output
Running Sphinx v8.1.0
loading translations [en]... done

Extension error:
Could not import extension sphinxcontrib.mermaid (exception: cannot import name 'ExtensionError' from 'sphinx.util' (/path/to/my_env/lib/python3.11/site-packages/sphinx/util/__init__.py))

However, with sphinx 8.0.x, it builds fine.

Steps to reproduce

  1. Install sphinxcontrib.mermaid 0.9.2 and sphinx 8.1.0, and add the extension.
  2. Run sphinx-build.
  3. Build fails.

Screenshots

No response

Code Sample

No response

Setup

  • Mermaid version: 0.9.2
  • sphinx version: 8.1.0

Suggested Solutions

Maybe find alternative to sphinx.util.ExtensionError?
I don't see any explicit reference to dropping it in the sphinx changelog: https://www.sphinx-doc.org/en/master/changes/index.html

Additional Context

No response

@IHMEkaleb
Copy link
Author

Filed issue with sphinx: sphinx-doc/sphinx#13002

@AA-Turner
Copy link

AA-Turner commented Oct 10, 2024

This isn't an issue with mermaid-js and can be closed.

A

@IHMEkaleb
Copy link
Author

This isn't an issue with mermaid-js and can be closed.

A

Sphinx maintainers recommend using "the proper import location for sphinx.errors.ExtensionError": sphinx-doc/sphinx#13002 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

No branches or pull requests

2 participants