From a0861b5b296465de2389742859d1abc5d8052bbc Mon Sep 17 00:00:00 2001 From: Dylan Verheul Date: Wed, 17 Apr 2024 10:55:56 +0200 Subject: [PATCH] Replace sphinx_mdinclude with MyST (#709) --- .readthedocs.yml => .readthedocs.yaml | 0 docs/authors.rst | 3 ++- docs/changelog.rst | 3 ++- docs/conf.py | 2 +- docs/requirements.txt | 6 +++--- 5 files changed, 8 insertions(+), 6 deletions(-) rename .readthedocs.yml => .readthedocs.yaml (100%) diff --git a/.readthedocs.yml b/.readthedocs.yaml similarity index 100% rename from .readthedocs.yml rename to .readthedocs.yaml diff --git a/docs/authors.rst b/docs/authors.rst index e83eebba..85dc9c54 100644 --- a/docs/authors.rst +++ b/docs/authors.rst @@ -1 +1,2 @@ -.. mdinclude:: ../AUTHORS \ No newline at end of file +.. include:: ../AUTHORS + :parser: myst_parser.sphinx_ diff --git a/docs/changelog.rst b/docs/changelog.rst index 5ec4a0ec..4afc7d3f 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1 +1,2 @@ -.. mdinclude:: ../CHANGELOG.md \ No newline at end of file +.. include:: ../CHANGELOG.md + :parser: myst_parser.sphinx_ diff --git a/docs/conf.py b/docs/conf.py index 46810fd5..25d1e833 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,7 +15,7 @@ extensions = [ "sphinx.ext.autodoc", "sphinx.ext.viewcode", - "sphinx_mdinclude", + "myst_parser", ] htmlhelp_basename = f"{project}-doc" diff --git a/docs/requirements.txt b/docs/requirements.txt index cb2e9af4..67699eba 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ -sphinx>=7.2.6 -sphinx-mdinclude>=0.5.3 -furo>=2023.05.20 +sphinx==7.3.5 +myst-parser==2.0.0 +furo==2024.1.29