Skip to content

Commit

Permalink
Update top level Sphinx doc to be able to replace https://matpower.or…
Browse files Browse the repository at this point in the history
  • Loading branch information
rdzman committed May 6, 2024
1 parent e3b3398 commit 16631cd
Showing 1 changed file with 79 additions and 9 deletions.
88 changes: 79 additions & 9 deletions docs/sphinx/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,65 @@
|MATPOWER| Documentation
########################

..
.. note::
.. toctree::
:caption: Home

This is a very incomplete **work-in-progress**!
matpower.org <https://matpower.org>

.. toctree::
:maxdepth: 1
:caption: Get Started

Home (matpower.org) <https://matpower.org>
Get Started <https://matpower.org/about/get-started/>

------------------------------------

Overview
========

The documentation for |MATPOWER| and its related packages are distributed across several manuals and How To Guides. The goal is to make all of this documentation available in HTML format, with some of the manuals available in PDF format as well. To facilitate this goal, the source for new documentation will be written in `reStructured Text <https://www.writethedocs.org/guide/writing/reStructuredText/>`_ format for processing by `Sphinx <https://www.sphinx-doc.org/>`_ to build the HTML and PDF versions from a single source.
..
|MATPOWER| is a package of free, open-source Matlab-language M-files for solving steady-state power system simulation and optimization problems. It is built on |MPOM>|, a package for constructing and solving mathematical programming and optimization problems. |MPOM>| in turn relies on |MIPS>| (|MIPSname|) as a default solver. And |MOST>| (|MOSTname|), built on top of |MATPOWER|, is a framework for solving generalized steady-state electric power scheduling problems. All of them rely on |MPTEST>| as a software testing framework.

|MATPOWER| is a package of free, open-source Matlab-language functions and classes for simulating and optimizing steady-state power system problems. It includes the following sub-packages.

.. list-table::
:widths: 22 58 20
:header-rows: 1
:class: longtable

* - Package
- Description
- Requires
* - |MATPOWER>|
- steady-state power system simulation and optimization
- |MPOM|
* - |MPOM>|
- tools for constructing and solving mathematical programming and optimization problems
- |MIPS|
* - |MIPS>|
- |MIPSname|, nonlinear programming (NLP) solver
- |MPTEST|
* - |MPTEST>|
- software testing framework and utility functions
- |MATLAB|/Octave
* - |MOST>|
- |MOSTname|, framework for generalized steady-state electric power scheduling problems
- |MATPOWER|
* - |MATPOWER-Extras>|
- additional contributed packages for use with |MATPOWER|
- |MATPOWER|

The documentation for |MATPOWER| can be found in the various Manuals, How To Guides, and Tech Notes on this site. Each function or class has its own reference documentation which can be accessed via the built-in ``help`` command in |MATLAB| or Octave, or by consulting the corresponding Reference manual.

Currently, most of the User's Manuals are still available only as PDF, built from the legacy LaTeX source.
Changes to |MATPOWER| in each released version are summarized in the `release notes <https://github.com/MATPOWER/matpower/blob/master/docs/relnotes>`_, found on GitHub in ``docs/relnotes`` and in Appendix H of the |MUM|. A complete, detailed change log, even for unreleased versions, is available in the `CHANGES.md <https://github.com/MATPOWER/matpower/blob/master/CHANGES.md>`_ file.


.. note::

The goal is to make all |MATPOWER| documentation available in HTML format, with some of the manuals also available as PDF. To facilitate this, new documentation is written in `reStructured Text <https://www.writethedocs.org/guide/writing/reStructuredText/>`_ format for processing by `Sphinx <https://www.sphinx-doc.org/>`_, so the HTML and PDF versions can be built from a single source.

Currently, most of the User's Manuals are still only available as PDF, built from the legacy LaTeX source.

|MATPOWER| is a package of free, open-source Matlab-language M-files for solving steady-state power system simulation and optimization problems. It is built on |MPOM>|, a package for constructing and solving mathematical programming and optimization problems. |MPOM>| in turn relies on |MIPS>| (|MIPSname|) as a default solver. And |MOST>| (|MOSTname|), built on top of |MATPOWER|, is a framework for solving generalized steady-state electric power scheduling problems. All of them rely on |MPTEST>| as a software testing framework.

------------------------------------

Expand All @@ -40,6 +79,9 @@ Currently, most of the User's Manuals are still available only as PDF, built fro
dev-manual/index
ref-manual/index

More Manuals
------------

.. toctree::
:maxdepth: 1

Expand All @@ -48,10 +90,17 @@ Currently, most of the User's Manuals are still available only as PDF, built fro
mpom/index
most/index

All Legacy PDF Manuals
----------------------

.. toctree::

All Legacy PDF Manuals <https://matpower.org/doc/manuals/>

------------------------------------

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: How To Guides

howto/element
Expand All @@ -62,6 +111,27 @@ Currently, most of the User's Manuals are still available only as PDF, built fro

------------------------------------

.. toctree::
:maxdepth: 2
:caption: Tech Notes

tech-notes

------------------------------------

Publications
============

For additional |MATPOWER|-related publications, see:

- `Publications <https://matpower.org/publications>`_

Please `cite <https://matpower.org/citing>`_ |MATPOWER| in your own publications derived from the use of |MATPOWER|.

- `Citing <https://matpower.org/citing>`_ |MATPOWER|

------------------------------------

.. toctree::
:caption: Other Links

Expand Down

0 comments on commit 16631cd

Please sign in to comment.