Skip to content
This repository has been archived by the owner on Aug 25, 2024. It is now read-only.

docs: conf: extensions: Enable mermaid diagram extension #1187

Open
johnandersen777 opened this issue Aug 4, 2021 · 1 comment
Open

docs: conf: extensions: Enable mermaid diagram extension #1187

johnandersen777 opened this issue Aug 4, 2021 · 1 comment
Labels
documentation Changes to documentation enhancement New feature or request

Comments

@johnandersen777
Copy link

diff --git a/docs/conf.py b/docs/conf.py
index a31b24ea4..ebc2fa543 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -64,6 +64,7 @@ extensions = [
     "literalinclude_relative",
     "nbsphinx",
     "nbsphinx_link",
+    "sphinxcontrib-mermaid",
 ]

 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
diff --git a/requirements-dev.txt b/requirements-dev.txt
index a9faeb6de..227d3598c 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -21,3 +21,4 @@ matplotlib
 # Needed to run DataFrame test, not required for module
 pandas>=1.0
 lxml>=4.6.3
+sphinxcontrib-mermaid>=0.7.1
@johnandersen777 johnandersen777 added enhancement New feature or request documentation Changes to documentation labels Aug 4, 2021
@johnandersen777
Copy link
Author

Blocked by mgaitan/sphinxcontrib-mermaid#74

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Changes to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant