From 8807da4b6beb537f66b8cb99dc24d0d2c496c4b2 Mon Sep 17 00:00:00 2001
From: Nils Brueggemann <nils.brueggemann@mpimet.mpg.de>
Date: Tue, 18 Mar 2025 21:53:15 +0100
Subject: [PATCH] doc: Allow for markdown files in documentation.
---
doc/conf.py | 6 +++++-
requirements_documentation.txt | 1 +
2 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/doc/conf.py b/doc/conf.py
index 6df820a..1415844 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -39,6 +39,7 @@ extensions = [
'sphinx_copybutton',
'sphinx.ext.autosummary',
'sphinx.ext.napoleon',
+ 'myst_parser',
]
# Add any paths that contain templates here, relative to this directory.
@@ -48,7 +49,10 @@ templates_path = ['_templates']
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = {
+ '.rst': 'restructuredtext',
+ '.md': 'markdown',
+}
# The master toctree document.
master_doc = 'index'
diff --git a/requirements_documentation.txt b/requirements_documentation.txt
index a23af60..928f909 100644
--- a/requirements_documentation.txt
+++ b/requirements_documentation.txt
@@ -4,3 +4,4 @@ nbsphinx-link
sphinx_copybutton
pydata_sphinx_theme
#docutils=0.20
+myst-parser
--
GitLab