Merge pull request #209 from jhlegarreta/IncludeMarkdownDocInSphinx

DOC: Add Markdown tutorial files to the documentation
SlicerDMRI · Oct 24, 2023 · ba9f379 · ba9f379
2 parents 84b2da1 + 3e3590b
commit ba9f379
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -15,6 +15,7 @@ build:
     - liblapack-dev
   jobs:
     pre_build:
+      - pip install --upgrade myst-parser
       - sphinx-apidoc -f -o doc .
 
 # Build documentation in the doc/ directory with Sphinx

diff --git a/doc/conf.py b/doc/conf.py
@@ -66,6 +66,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "myst_parser",
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
 ]
@@ -79,7 +80,7 @@
 exclude_patterns = ["*tests*"]
 
 # Sources
-source_suffix = ".rst"
+source_suffix = [".rst", ".md"]
 
 # The master toctree document.
 master_doc = "index"

diff --git a/doc/index.rst b/doc/index.rst
@@ -17,6 +17,13 @@ tools.
    bin
    utilities
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Tutorials
+
+   bundles
+   subject-specific-tractography-parcellation
+
 Indices and tables
 ==================