Skip to content

Commit

Permalink
Integrating PyROS documentation into RTD build
Browse files Browse the repository at this point in the history
Slightly reorganizing the contributed packages so that the TOC is a
little more intuitive.  Clarifying some contrib package doc page titles.
  • Loading branch information
jsiirola committed Jun 7, 2021
1 parent 366b735 commit 059c217
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 13 deletions.
15 changes: 11 additions & 4 deletions doc/OnlineDocs/contributed_packages/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,24 @@ Contributed packages distributed with Pyomo:

community.rst
gdpopt.rst
mcpp.rst
mindtpy.rst
multistart.rst
parmest/index.rst
preprocessing.rst
parmest/index.rst
pynumero/index.rst
satsolver.rst
pyros.rst
sensitivity_toolbox.rst

Contributed Pyomo interfaces to other packages:

.. toctree::
:maxdepth: 1

mcpp.rst
satsolver.rst


Contributed packages distributed independently of Pyomo, but accessible
through ``pyomo.contrib``:

* `pyomo.contrib.simplemodel <http://pyomocontrib-simplemodel.readthedocs.io/en/latest/source.html>`_
* `pyomo.contrib.simplemodel <http://pyomo-simplemodel.readthedocs.io/en/latest>`_
4 changes: 2 additions & 2 deletions doc/OnlineDocs/contributed_packages/mcpp.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Pyomo Interface to MC++
=======================
MC++ Interface
==============

The Pyomo-MC++ interface allows for bounding of factorable functions using the MC++ library developed by
the OMEGA research group at Imperial College London.
Expand Down
6 changes: 3 additions & 3 deletions doc/OnlineDocs/contributed_packages/parmest/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
parmest
=======
Parameter Estimation with `parmest`
===================================

parmest is a Python package built on the Pyomo optimization modeling
`parmest` is a Python package built on the Pyomo optimization modeling
language ([PyomoJournal]_, [PyomoBookII]_) to support parameter estimation using experimental data along with
confidence regions and subsequent creation of scenarios for PySP.

Expand Down
4 changes: 2 additions & 2 deletions doc/OnlineDocs/contributed_packages/preprocessing.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Pyomo Nonlinear Preprocessing
=============================
Nonlinear Preprocessing Transformations
=======================================

``pyomo.contrib.preprocessing`` is a contributed library of preprocessing
transformations intended to operate upon nonlinear and mixed-integer nonlinear
Expand Down
4 changes: 2 additions & 2 deletions doc/OnlineDocs/contributed_packages/satsolver.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Pyomo Interface to z3 SMT Sat Solver
====================================
z3 SMT Sat Solver Interface
===========================

The z3 Satisfiability Solver interface can convert pyomo variables and expressions for
use with the z3 Satisfiability Solver
Expand Down

0 comments on commit 059c217

Please sign in to comment.