DOC: Use myst-parser for README

equinor · Jun 18, 2024 · 0fbe498 · 0fbe498
1 parent 74b02c4
commit 0fbe498
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -41,6 +41,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
+    "myst_parser",
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",

diff --git a/docs/readme.rst b/docs/readme.rst
@@ -1 +1,2 @@
-.. include:: ../README.rst
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
diff --git a/pyproject.toml b/pyproject.toml
@@ -68,6 +68,7 @@ tests = [
     "types-PyYAML",
 ]
 docs = [
+    "myst-parser",
     "sphinx",
     "sphinx-argparse",
     "sphinx-autodoc-typehints",
@@ -128,4 +129,4 @@ select = [
 ]
 
 [tool.ruff.lint.isort]
-combine-as-imports = true
+combine-as-imports = true