From da697926738cf214487579565c863f27306d90cf Mon Sep 17 00:00:00 2001 From: endolith Date: Mon, 18 Nov 2024 11:38:39 -0500 Subject: [PATCH] myst_parser --- docs/conf.py | 4 ++-- docs/index.rst | 3 ++- docs/requirements.txt | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 48fb63d..3abb1dc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -34,7 +34,7 @@ 'sphinx.ext.autodoc', 'sphinx.ext.extlinks', 'numpydoc', - 'm2r2', + 'myst_parser', 'sphinxcontrib.mermaid', ] @@ -67,7 +67,7 @@ source_suffix = { '.rst': 'restructuredtext', - '.md': 'm2r2', + '.md': 'markdown', } # Configure m2r2 diff --git a/docs/index.rst b/docs/index.rst index 45052ee..5f7901a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,8 @@ :maxdepth: 2 :caption: Contents: -.. mdinclude:: ../README.md +.. include:: ../README.md + :parser: myst_parser.sphinx_ diff --git a/docs/requirements.txt b/docs/requirements.txt index 4a7651e..714837d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,7 @@ -e . sphinx>=4.0 numpydoc -m2r2 +myst-parser sphinxcontrib.mermaid sphinx_rtd_theme sphinxcontrib-apidoc \ No newline at end of file