From 5428269443faea765e5421f6414f83b959f36c14 Mon Sep 17 00:00:00 2001 From: Dylan Verheul Date: Thu, 18 Apr 2024 08:46:13 +0200 Subject: [PATCH] Replace sphinx_mdinclude with MyST (#587) --- .readthedocs.yml => .readthedocs.yaml | 0 docs/changelog.rst | 3 ++- docs/conf.py | 2 +- docs/contributing.rst | 3 ++- docs/migrate.rst | 3 ++- docs/requirements.txt | 6 +++--- 6 files changed, 10 insertions(+), 7 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/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/contributing.rst b/docs/contributing.rst index 4fc50161..6889b7c4 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1 +1,2 @@ -.. mdinclude:: ../CONTRIBUTING.md +.. include:: ../CONTRIBUTING.md + :parser: myst_parser.sphinx_ diff --git a/docs/migrate.rst b/docs/migrate.rst index aff377ed..ce5ce42f 100644 --- a/docs/migrate.rst +++ b/docs/migrate.rst @@ -1 +1,2 @@ -.. mdinclude:: ../MIGRATE.md \ No newline at end of file +.. include:: ../MIGRATE.md + :parser: myst_parser.sphinx_ diff --git a/docs/requirements.txt b/docs/requirements.txt index cb2e9af4..698ac548 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 +furo==2024.1.29 +myst-parser==2.0.0