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

DM-46777: sphinx < 8.1.0 #230

Merged
merged 1 commit into from
Oct 10, 2024
Merged

DM-46777: sphinx < 8.1.0 #230

merged 1 commit into from
Oct 10, 2024

Conversation

fajpunk
Copy link
Member

@fajpunk fajpunk commented Oct 10, 2024

Sphinx 8.1.0 contains a commit that removes the ExtensionError export from the sphinx.util package. This currently breaks the 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_object
ImportError: 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).

[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)
@fajpunk fajpunk force-pushed the tickets/DM-46777/mermaid-compat branch from 76a1ce3 to e85f2f4 Compare October 10, 2024 18:35
@fajpunk fajpunk merged commit 62db5bc into main Oct 10, 2024
8 checks passed
@fajpunk fajpunk deleted the tickets/DM-46777/mermaid-compat branch October 10, 2024 18:40
@jonathansick
Copy link
Member

@fajpunk and @rra if you need to merge this for the current 1.x user base, keep in mind that the main branch is gearing up for a major 2.0 release with breaking changes. So I'd suggest making a 1.0 release maintenance branch from the last 1.x release tag; cherry picking this commit to a new branch merging into 1.0 and then making the new 1.x.y patch release from the 1.0 branch.

@fajpunk fajpunk mentioned this pull request Oct 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants