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.

Sign up for GitHub

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

Jump to bottom

DM-46777: Add a lower bound on sphinxcontrib-mermaid, revert sphinx pin #233

Merged
merged 2 commits into from
Oct 15, 2024
Merged

DM-46777: Add a lower bound on sphinxcontrib-mermaid, revert sphinx pin #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5551bd
DM-46777: Add a lower bound on sphinxcontrib-mermaid, revert sphinx pin
fajpunk Oct 15, 2024
dbf6183
mpyp 1.12 doesn't consider this reexported anymore, but it's fine
fajpunk Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion changelog.d/20241010_133336_danfuchs_mermaid_compat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +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.
- Bump `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with sphinx==1.8.1, and allows us to unpin the version of mermaid JS.

4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
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,<8.1.0", # Consistent docutils constraint, mermaid compatibility
"Sphinx>=7", # Consistent docutils constraint
"PyYAML",
"GitPython",
"requests",
Expand Down Expand Up @@ -74,7 +74,7 @@ guide = [
"myst-parser",
"myst-nb",
"markdown-it-py[linkify]",
"sphinxcontrib-mermaid",
"sphinxcontrib-mermaid>=1",
"sphinxext-opengraph",
"sphinxcontrib-redoc",
"sphinxcontrib-jquery",
Expand Down
5 changes: 0 additions & 5 deletions src/documenteer/conf/guide.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@
"myst_enable_extensions",
# MERMAID
"mermaid_output_format",
"mermaid_version",
# OPENGRAPH
"ogp_site_url",
"ogp_site_name",
Expand Down Expand Up @@ -439,10 +438,6 @@
# Mermaid CLI installation
mermaid_output_format = "raw"

# Temporary workaround for not getting mermaid 10 successfully from unpkg
# https://github.com/mgaitan/sphinxcontrib-mermaid/issues/110
mermaid_version = "9.4.0"

# ============================================================================
# #OPENGRAPH OpenGraph diagram support
# https://github.com/wpilibsuite/sphinxext-opengraph
Expand Down
2 changes: 1 addition & 1 deletion src/documenteer/ext/remotecodeblock.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from docutils.parsers.rst import directives
from sphinx.application import Sphinx
from sphinx.directives.code import LiteralIncludeReader, container_wrapper
from sphinx.util import logging, parselinenos
from sphinx.util import logging, parselinenos # type: ignore[attr-defined]
from sphinx.util.docutils import SphinxDirective
from sphinx.util.nodes import set_source_info
from sphinx.util.typing import ExtensionMetadata
Expand Down