Add Sphinx-based Reference documentation.

CHANGES.md

@@ -2,6 +2,13 @@ Change history for MP-Test
 ==========================
 
 
+Since 8.0b1
+-----------
+
+#### 3/1/24
+  - Add Sphinx-based Reference documentation.
+
+
 Version 8.0b1 - *Dec 12, 2022*
 ------------------------------
 

docs/sphinx/source/conf.py

@@ -1,6 +1,7 @@
 # Configuration file for the Sphinx documentation builder.
 #
-# For the full list of built-in configuration values, see the documentation:
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Path setup --------------------------------------------------------------
@@ -17,22 +18,28 @@
 
 
 # -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'MP-Test'
-copyright = '1996-2022, Power Systems Engineering Research Center (PSERC)'
+copyright = '1996-2024, Power Systems Engineering Research Center (PSERC)'
 author = 'Ray D. Zimmerman'
-release = '7.2'
+
+# The full version, including alpha/beta/rc tags
+release = '7.1+'
+
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
     'sphinxcontrib.matlab',
+    'sphinx.ext.autodoc',
     'sphinx.ext.extlinks',
+    'sphinx.ext.napoleon',
     'sphinx_rtd_theme',
     'sphinx_tabs.tabs',
 ]
+this_dir = os.path.dirname(os.path.abspath(__file__))
+matlab_src_dir = os.path.abspath(os.path.join(this_dir, 'matlab-source'))
 primary_domain = 'mat'
 
 templates_path = ['_templates']
@@ -63,6 +70,21 @@
 
 # -- Other Options -----------------------------------------------------------
 
+matlab_short_links = True
+# matlab_auto_link = "basic"
+matlab_auto_link = "all"
+matlab_show_property_default_value = True
+# autoclass_content = 'both'         # 'class', 'init', 'both'
+autodoc_member_order = 'bysource'   # 'alphabetical', 'groupwise', 'bysource'
+napoleon_use_param = False
+napoleon_use_rtype = False
+napoleon_custom_sections = [
+    ('Input', 'params_style'),
+    ('Inputs', 'params_style'),
+    ('Output', 'params_style'),
+    ('Outputs', 'params_style'),
+]
+
 rst_prolog = """
 .. include:: /mp-docs-shared/prolog.rst.txt
 """
@@ -76,7 +98,8 @@
     'figure': 'Figure %s',
     'code-block': 'Listing %s',
     'section': 'Section %s' }
-highlight_language = 'matlab'
+highlight_language = 'octave'   # 'matlab' has issues with '...'
+                                # e.g. y = fcn(x, ...)
 math_number_all = True
 math_eqref_format = '({number})'
 
@@ -91,9 +114,9 @@
 
 with open('mp-docs-shared/mathCmds.tex.txt', 'r') as f:
     for line in f:
-        macros = re.findall(r'\\newcommand{\\(.*?)}(\[(\d)\])?{(.+)}', line)
+        macros = re.findall(r'\\(re)?newcommand{\\(.*?)}(\[(\d)\])?{(.+)}', line)
         for macro in macros:
-            if len(macro[1]) == 0:
-                mathjax3_config['tex']['macros'][macro[0]] = "{"+macro[3]+"}"
+            if len(macro[2]) == 0:
+                mathjax3_config['tex']['macros'][macro[1]] = macro[4]
             else:
-                mathjax3_config['tex']['macros'][macro[0]] = ["{"+macro[3]+"}", int(macro[2])]
+                mathjax3_config['tex']['macros'][macro[1]] = [macro[4], int(macro[3])]

docs/sphinx/source/functions/have_feature.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/have_feature.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+have_feature
+------------
+
+.. autofunction:: have_feature

docs/sphinx/source/functions/have_feature_matlab.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/have_feature_matlab.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+have_feature_matlab
+-------------------
+
+.. autofunction:: have_feature_matlab

docs/sphinx/source/functions/have_feature_octave.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/have_feature_octave.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+have_feature_octave
+-------------------
+
+.. autofunction:: have_feature_octave

docs/sphinx/source/functions/mptestver.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/mptestver.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+mptestver
+---------
+
+.. autofunction:: mptestver

docs/sphinx/source/functions/t_begin.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t_begin.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_begin
+-------
+
+.. autofunction:: t_begin

docs/sphinx/source/functions/t_end.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t_end.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_end
+-----
+
+.. autofunction:: t_end

docs/sphinx/source/functions/t_file_match.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t_file_match.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_file_match
+------------
+
+.. autofunction:: t_file_match

docs/sphinx/source/functions/t_have_feature.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t/t_have_feature.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_have_feature
+--------------
+
+.. autofunction:: t_have_feature

docs/sphinx/source/functions/t_is.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t_is.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_is
+----
+
+.. autofunction:: t_is

docs/sphinx/source/functions/t_ok.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t_ok.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_ok
+----
+
+.. autofunction:: t_ok

docs/sphinx/source/functions/t_run_tests.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t_run_tests.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_run_tests
+-----------
+
+.. autofunction:: t_run_tests

docs/sphinx/source/functions/t_skip.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t_skip.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_skip
+------
+
+.. autofunction:: t_skip

docs/sphinx/source/functions/t_str_match.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t_str_match.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_str_match
+-----------
+
+.. autofunction:: t_str_match

docs/sphinx/source/functions/t_test_fcns.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t/t_test_fcns.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+t_test_fcns
+-----------
+
+.. autofunction:: t_test_fcns

docs/sphinx/source/functions/test_mptest.rst

@@ -0,0 +1,8 @@
+.. automodule:: mptest
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/matpower/blob/master/lib/t/test_mptest.m" target=_blank><svg height="32" aria-hidden="true" viewBox="0 0 16 16" version="1.1" width="32" data-view-component="true" class="octicon octicon-mark-github v-align-middle color-fg-default"><path d="M8 0c4.42 0 8 3.58 8 8a8.013 8.013 0 0 1-5.45 7.59c-.4.08-.55-.17-.55-.38 0-.27.01-1.13.01-2.2 0-.75-.25-1.23-.54-1.48 1.78-.2 3.65-.88 3.65-3.95 0-.88-.31-1.59-.82-2.15.08-.2.36-1.02-.08-2.12 0 0-.67-.22-2.2.82-.64-.18-1.32-.27-2-.27-.68 0-1.36.09-2 .27-1.53-1.03-2.2-.82-2.2-.82-.44 1.1-.16 1.92-.08 2.12-.51.56-.82 1.28-.82 2.15 0 3.06 1.86 3.75 3.64 3.95-.23.2-.44.55-.51 1.07-.46.21-1.61.55-2.33-.66-.15-.24-.6-.83-1.23-.82-.67.01-.27.38.01.53.34.19.73.9.82 1.13.16.45.68 1.31 2.69.94 0 .67.01 1.3.01 1.49 0 .21-.15.45-.55.38A7.995 7.995 0 0 1 0 8c0-4.42 3.58-8 8-8Z"></path></svg></a></div>`
+
+test_mptest
+-----------
+
+.. autofunction:: test_mptest

docs/sphinx/source/index.rst

@@ -2,10 +2,10 @@
 |MPTEST| User's Manual
 ######################
 
-.. toctree::
-   :maxdepth: 2
-   :numbered: 3
-
 .. note::
 
    The new web-based version of the |MPTEST| User's Manual is not yet available. Please, continue to use the |MPTESTman| on GitHub for now.
+
+.. toctree::
+
+   reference

docs/sphinx/source/matlab-source/mptest/have_feature.m

@@ -0,0 +1 @@
+../../../../../lib/have_feature.m

docs/sphinx/source/matlab-source/mptest/have_feature_matlab.m

@@ -0,0 +1 @@
+../../../../../lib/have_feature_matlab.m

docs/sphinx/source/matlab-source/mptest/have_feature_octave.m

@@ -0,0 +1 @@
+../../../../../lib/have_feature_octave.m

docs/sphinx/source/matlab-source/mptest/mptestver.m

@@ -0,0 +1 @@
+../../../../../lib/mptestver.m

docs/sphinx/source/matlab-source/mptest/t_begin.m

@@ -0,0 +1 @@
+../../../../../lib/t_begin.m

docs/sphinx/source/matlab-source/mptest/t_end.m

@@ -0,0 +1 @@
+../../../../../lib/t_end.m

docs/sphinx/source/matlab-source/mptest/t_file_match.m

@@ -0,0 +1 @@
+../../../../../lib/t_file_match.m

docs/sphinx/source/matlab-source/mptest/t_have_feature.m

@@ -0,0 +1 @@
+../../../../../lib/t/t_have_feature.m

docs/sphinx/source/matlab-source/mptest/t_is.m

@@ -0,0 +1 @@
+../../../../../lib/t_is.m

docs/sphinx/source/matlab-source/mptest/t_ok.m

@@ -0,0 +1 @@
+../../../../../lib/t_ok.m

docs/sphinx/source/matlab-source/mptest/t_run_tests.m

@@ -0,0 +1 @@
+../../../../../lib/t_run_tests.m

docs/sphinx/source/matlab-source/mptest/t_skip.m

@@ -0,0 +1 @@
+../../../../../lib/t_skip.m

docs/sphinx/source/matlab-source/mptest/t_str_match.m

@@ -0,0 +1 @@
+../../../../../lib/t_str_match.m

docs/sphinx/source/matlab-source/mptest/t_test_fcns.m

@@ -0,0 +1 @@
+../../../../../lib/t/t_test_fcns.m

docs/sphinx/source/matlab-source/mptest/test_mptest.m

@@ -0,0 +1 @@
+../../../../../lib/t/test_mptest.m