Add proper Introduction section to Ref Manual + other minor udpates.

MATPOWER · Nov 21, 2023 · ab1dc63 · ab1dc63
1 parent 0921f31
commit ab1dc63
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 3 deletions.
diff --git a/docs/sphinx/source/ref-manual/classes/index.rst b/docs/sphinx/source/ref-manual/classes/index.rst
@@ -233,8 +233,6 @@ Elements
 Miscellaneous Classes
 ---------------------
 
-:hl:`Include description of this category of classes here.`
-
 .. toctree::
    :name: sec_misc_classes
 

diff --git a/docs/sphinx/source/ref-manual/functions/index.rst b/docs/sphinx/source/ref-manual/functions/index.rst
@@ -3,10 +3,12 @@
 Functions
 =========
 
+.. _ref_top_level_functions:
+
 Top-Level Simulation Functions
 ------------------------------
 
-Could include description of this category of functions here.
+These are top-level functions intended as user commands for running power flow (PF), continuation power flow (CPF), optimal power flow (OPF) and other custom simulation or optimization tasks.
 
 .. toctree::
 

diff --git a/docs/sphinx/source/ref-manual/index.rst b/docs/sphinx/source/ref-manual/index.rst
@@ -13,5 +13,6 @@
 .. toctree::
    :numbered: 2
 
+   introduction
    functions/index
    classes/index
diff --git a/docs/sphinx/source/ref-manual/introduction.rst b/docs/sphinx/source/ref-manual/introduction.rst
@@ -0,0 +1,10 @@
+Introduction
+============
+
+The purpose of this *Reference Manual* is to provide reference documentation on each class and function in |MATPOWER|.
+
+This documentation is automatically generated from the corresponding help text in the Matlab source for each function, class, property or method.
+
+The GitHub icon in the upper right of each reference page links to the corresponding source file in the master branch on GitHub.
+
+Currently, this manual includes *only* classes and functions that make up the new **MP-Core** and the **flexible** |MATPOWER| framework, but not the **legacy** |MATPOWER| framework  or the other packages such as |MPOM>|, |MIPS>|, |MPTEST>|, or |MOST>|.