Skip to content

Commit

Permalink
DM-46777: Lower bound on sphinxcontrib-mermaid, revert sphinx pin
Browse files Browse the repository at this point in the history
* Set a lower bound on sphinxcontrib-mermaid to <=1
* Revert the Sphinx pin because this fixes the compatibility issue
* Ditch the `mermaid_version` pin because this fixes
mgaitan/sphinxcontrib-mermaid#110
  • Loading branch information
fajpunk committed Oct 15, 2024
1 parent 62db5bc commit 3b6e38f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 7 deletions.
4 changes: 2 additions & 2 deletions 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,<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
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

0 comments on commit 3b6e38f

Please sign in to comment.