Skip to content

Commit

Permalink
DM-46777: sphinx < 8.1.0
Browse files Browse the repository at this point in the history
[Sphinx
8.1.0](sphinx-doc/sphinx@v8.0.2...v8.1.0)
contains [a
commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14)
that removes the `ExtensionError` export from the `sphinx.util` package.
This currently breaks the
[sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid)
dependency:

```
File
"/home/danfuchs/src/safir/.nox/docs-clean/lib/python3.12/site-packages/sphinxcontrib/autoclassdiag.py",
line 3, in <module>    from sphinx.util import ExtensionError,
import_objectImportError: cannot import name 'ExtensionError' from
'sphinx.util'
(/home/danfuchs/src/safir/.nox/docs-clean/lib/python3.12/site-packages/sphinx/util/__init__.py)
```

Pin to < 8.1.0 for now until this gets fixed in either sphinx or
sphinxcontrib-mermaid (and any other packages that we use that might
also be broken)
  • Loading branch information
fajpunk committed Oct 10, 2024
1 parent bc15803 commit e85f2f4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions changelog.d/20241010_133336_danfuchs_mermaid_compat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
### Bug fixes

- Pin `sphinx` to < 8.1.0. [Sphinx 8.1.0](https://github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) contains [a commit](https://github.com/sphinx-doc/sphinx/pull/12762/files#diff-a4c6bf1492ef480b94af82c988f64ca56fa256fab0ed043a5ad3d4043f89a645L14) that removes the `ExtensionError` export from the `sphinx.util` package. This currently breaks the [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) dependency.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ requires-python = ">=3.11"
dynamic = ["version"]
dependencies = [
"docutils>=0.20", # solves an extra div bug with the bibliography directive
"Sphinx>=7", # Consistent docutils constraint
"Sphinx>=7,<8.1.0", # Consistent docutils constraint, mermaid compatibility
"PyYAML",
"GitPython",
"requests",
Expand Down

0 comments on commit e85f2f4

Please sign in to comment.