Merge pull request #160 from hrcorval/release_4.0.7

Completing documentation changes
hrcorval · Oct 8, 2024 · 413c2ec · 413c2ec
2 parents b78c9d1 + 225b041
commit 413c2ec
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -7,7 +7,7 @@
 
 # -- General configuration ---------------------------------------------------
 extensions = [
-    'recommonmark',
+    'myst_parser',
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
 ]
@@ -24,3 +24,8 @@
 
 # -- Options for HTML output -------------------------------------------------
 html_theme = 'sphinx_rtd_theme'
+
+# -- MyST Parser configuration -----------------------------------------------
+myst_enable_extensions = [
+    "colon_fence",
+]
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,12 +1,13 @@
 Welcome to BehaveX's documentation!
 ===================================
 
+.. include:: ../README.md
+   :parser: myst_parser
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   ../README.md
-
 Indices and tables
 ==================
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,3 @@
-recommonmark
+myst-parser
 sphinx
 sphinx_rtd_theme