Merge pull request #234 from lsst-sqre/tickets/DM-46777/release-1.4.2…

…-backport-revert-sphinx-pin

DM-46777: Release 1.4.2, backport revert sphinx pin

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-1.4.2'></a>
+## 1.4.2 (2024-10-15)
+
+### Bug fixes
+
+- Bump `sphinxcontrib-mermaid` to >= 1, which fixes an incompatibility with sphinx==1.8.1, and allows us to unpin the version of mermaid JS.
+
 <a id='changelog-1.4.1'></a>
 ## 1.4.1 (2024-10-10)
 

pyproject.toml

@@ -24,7 +24,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",
@@ -71,7 +71,7 @@ guide = [
     "myst-parser",
     "myst-nb",
     "markdown-it-py[linkify]",
-    "sphinxcontrib-mermaid",
+    "sphinxcontrib-mermaid>=1",
     "sphinxext-opengraph",
     "sphinxcontrib-redoc",
     "sphinxcontrib-jquery",

src/documenteer/conf/guide.py

@@ -103,7 +103,6 @@
     "myst_enable_extensions",
     # MERMAID
     "mermaid_output_format",
-    "mermaid_version",
     # OPENGRAPH
     "ogp_site_url",
     "ogp_site_name",
@@ -398,10 +397,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

src/documenteer/stackdocs/doxygen.py

@@ -1,5 +1,4 @@
-"""Configuration and execution of Doxygen at the stack level.
-"""
+"""Configuration and execution of Doxygen at the stack level."""
 
 __all__ = [
     "DoxygenConfiguration",
@@ -333,11 +332,7 @@ def render(self) -> str:
                 self._render_path_list(lines, tag_name, value)
             elif tag_field.type == List[str]:
                 self._render_str_list(lines, tag_name, value)
-            elif (
-                tag_field.type == Path
-                or tag_field.type
-                == Optional[Path]  # type: ignore[comparison-overlap]
-            ):
+            elif tag_field.type == Path or tag_field.type == Optional[Path]:
                 self._render_path(lines, tag_name, value)
         return "\n".join(lines) + "\n"