add MATLAB doc support

mu-biomed · Apr 10, 2023 · 6a41681 · 6a41681
1 parent da3cf73
commit 6a41681
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -10,7 +10,7 @@ jobs:
       - uses: actions/setup-python@v3
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx_rtd_theme
+          pip install sphinx sphinx_rtd_theme sphinxcontrib-matlabdomain
       - name: Sphinx build
         run: |
           sphinx-build doc _build

diff --git a/doc/conf.py b/doc/conf.py
@@ -2,6 +2,7 @@
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
+import os
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -14,15 +15,21 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = ['sphinx.ext.viewcode', 'sphinxcontrib.matlab','sphinx.ext.autodoc']
 
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 
-
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
+html_theme = 'bizstyle'
 html_static_path = ['_static']
+
+
+# -- MATLAB configuration ----------------------------------------------------
+primary_domain = 'mat'
+parent_dir = os.path.abspath(os.path.join(os.getcwd(), os.pardir))
+matlab_src_dir = os.path.join(parent_dir, 'src')
+