Add Sphinx-based Reference documentation.

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 --------------------------------------------------------------
@@ -20,19 +21,26 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'MIPS'
-copyright = '2009-2022, Power Systems Engineering Research Center (PSERC)'
+copyright = '2009-2024, Power Systems Engineering Research Center (PSERC)'
 author = 'Ray D. Zimmerman, Hongye Wang'
-release = '1.5'
+
+# The full version, including alpha/beta/rc tags
+release = '1.5+'
+
 
 # -- 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 +71,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 +99,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 +115,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_lu_vec.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/have_feature_lu_vec.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_lu_vec
+-------------------
+
+.. autofunction:: have_feature_lu_vec

docs/sphinx/source/functions/have_feature_pardiso.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/have_feature_pardiso.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_pardiso
+--------------------
+
+.. autofunction:: have_feature_pardiso

docs/sphinx/source/functions/have_feature_pardiso_legacy.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/have_feature_pardiso_legacy.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_pardiso_legacy
+---------------------------
+
+.. autofunction:: have_feature_pardiso_legacy

docs/sphinx/source/functions/have_feature_pardiso_object.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/have_feature_pardiso_object.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_pardiso_object
+---------------------------
+
+.. autofunction:: have_feature_pardiso_object

docs/sphinx/source/functions/mips.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/mips.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>`
+
+mips
+----
+
+.. autofunction:: mips

docs/sphinx/source/functions/mips_example1.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/t/mips_example1.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>`
+
+mips_example1
+-------------
+
+.. autofunction:: mips_example1

docs/sphinx/source/functions/mips_example2.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/t/mips_example2.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>`
+
+mips_example2
+-------------
+
+.. autofunction:: mips_example2

docs/sphinx/source/functions/mipsver.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/mipsver.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>`
+
+mipsver
+-------
+
+.. autofunction:: mipsver

docs/sphinx/source/functions/mplinsolve.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/mplinsolve.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>`
+
+mplinsolve
+----------
+
+.. autofunction:: mplinsolve

docs/sphinx/source/functions/qps_mips.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/qps_mips.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>`
+
+qps_mips
+--------
+
+.. autofunction:: qps_mips

docs/sphinx/source/functions/t_mips.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/t/t_mips.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_mips
+------
+
+.. autofunction:: t_mips

docs/sphinx/source/functions/t_mips_pardiso.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/t/t_mips_pardiso.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_mips_pardiso
+--------------
+
+.. autofunction:: t_mips_pardiso

docs/sphinx/source/functions/t_mplinsolve.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/t/t_mplinsolve.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_mplinsolve
+------------
+
+.. autofunction:: t_mplinsolve

docs/sphinx/source/functions/t_qps_mips.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/t/t_qps_mips.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_qps_mips
+----------
+
+.. autofunction:: t_qps_mips

docs/sphinx/source/functions/test_mips.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: mips
+
+:raw-html:`<div style="float: right"><a href="https://github.com/MATPOWER/mips/blob/master/lib/t/test_mips.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_mips
+---------
+
+.. autofunction:: test_mips

docs/sphinx/source/index.rst

@@ -1,11 +1,21 @@
-####################
-|MIPS| User's Manual
-####################
+##################
+MIPS User's Manual
+##################
 
 .. toctree::
    :maxdepth: 2
    :numbered: 3
 
 .. note::
 
-   The new web-based version of the |MIPS| User's Manual is not yet available. Please, continue to use the PDF version of the |MIPSman| for now.
+   The new web-based version of the MIPS User's Manual is not yet available. Please, continue to use the PDF version of the |MIPSman| for now.
+
+
+Reference
+=========
+
+The primary sources of documentation for MIPS, aside from the legacy PDF |MIPSman|, are this :ref:`sec_mips_reference` documentation and the built-in ``help`` command. As with the built-in functions and toolbox routines in |MATLAB>| and |Octave>|, you can type ``help`` followed by the name of a command or M-file to get help on that particular function.
+
+.. toctree::
+
+   reference

docs/sphinx/source/matlab-source/mips/have_feature_lu_vec.m

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

docs/sphinx/source/matlab-source/mips/have_feature_pardiso.m

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

docs/sphinx/source/matlab-source/mips/have_feature_pardiso_legacy.m

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

docs/sphinx/source/matlab-source/mips/have_feature_pardiso_object.m

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

docs/sphinx/source/matlab-source/mips/mips.m

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

docs/sphinx/source/matlab-source/mips/mips_example1.m

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

docs/sphinx/source/matlab-source/mips/mips_example2.m

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

docs/sphinx/source/matlab-source/mips/mipsver.m

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

docs/sphinx/source/matlab-source/mips/mplinsolve.m

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

docs/sphinx/source/matlab-source/mips/qps_mips.m

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

docs/sphinx/source/matlab-source/mips/t_mips.m

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

docs/sphinx/source/matlab-source/mips/t_mips_pardiso.m

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

docs/sphinx/source/matlab-source/mips/t_mplinsolve.m

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

docs/sphinx/source/matlab-source/mips/t_qps_mips.m

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