Try to switch to myst now that it supports mermaid

https://stackoverflow.com/a/76819611/125507
endolith · Nov 18, 2024 · 460652b · 460652b
1 parent d608e28
commit 460652b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,11 +32,11 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx.ext.extlinks',
-    'numpydoc',
-    'm2r2',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
     'sphinxcontrib.mermaid',
-    ]
+    'myst_parser'
+]
 
 extlinks = {
     'doi': ('https://dx.doi.org/%s', 'doi:%s'),
@@ -88,3 +88,6 @@ def copy_examples(app, docname):
 
 def setup(app):
     app.connect('build-finished', copy_examples)
+
+# Add this to enable regular markdown mermaid syntax
+myst_fence_as_directive = ["mermaid"]
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,9 +1,6 @@
-sphinx<7.0
-docutils==0.16
-mistune==0.8.4
-m2r2
+myst-parser
+sphinxcontrib.mermaid
 -e .
 numpydoc
-sphinxcontrib.mermaid
 sphinx_rtd_theme
 sphinxcontrib-apidoc