Merge pull request #164 from SANDAG/abm3_documentation

Changes to install mermaid for github docs
SANDAG · Jul 15, 2024 · 0da0aa0 · 0da0aa0
2 parents bacd9ad + fd3b0a9
commit 0da0aa0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs_requirements.txt b/docs_requirements.txt
@@ -14,3 +14,4 @@ mkdocstrings
 mkdocstrings-python
 mkdocs-table-reader-plugin
 numpy==1.26.4
+mkdocs-mermaid2-plugin
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -44,6 +44,7 @@ plugins:
      # custom_templates: templates
   - search
   - table-reader
+  - mermaid2
 
 nav:
   - Home: index.md
@@ -85,3 +86,9 @@ markdown_extensions:
   - pymdownx.keys
   - pymdownx.mark
   - pymdownx.tilde
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:mermaid2.fence_mermaid_custom
+