Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize the API documentation. #333

Merged
merged 2 commits into from
Feb 1, 2018
Merged

Reorganize the API documentation. #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c44aca2
Reorganize the API documentation.
jsiirola Jan 31, 2018
f42a918
Fix a typo identified by @qtothec
jsiirola Feb 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion doc/OnlineDocs/library_reference/contrib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
Third-Party Contributions
=========================

* `pyomo.contrib.simplemodel <http://pyomocontrib-simplemodel.readthedocs.io/en/latest/>`_
Pyomo includes a variety of additional features and functionality
provided by third parties through the ``pyomo.contrib`` package. This
package includes both contributions included with the main Pyomo
distribution and wrappers for third-party packages that must be
installed separately.

These packages are maintained by the original contributors and are
managed as *optional* Pyomo packages.

Contributed packages distributed with Pyomo:

*

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

* `pyomo.contrib.simplemodel <http://pyomocontrib-simplemodel.readthedocs.io/en/latest/source.html>`_

18 changes: 15 additions & 3 deletions doc/OnlineDocs/library_reference/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
Library Reference
=================

Pyomo is being increasingly used as a library to support Python
scripts. This section describes library APIs for key elements of Pyomo.
Pyomo is being increasingly used as a library embedded within larger
Python scripts or projects. This section describes the core library
APIs for key elements of Pyomo useful to application developers.

.. toctree::
:maxdepth: 1

kernel/index.rst
aml/index.rst
data/index.rst
solvers/index.rst

Pyomo is under active ongoing development. The following API
documentation describes *Beta* functionality.

.. toctree::
:maxdepth: 1
kernel/index.rst

Finally, Pyomo includes a number of third-party extensions:

.. toctree::
:maxdepth: 1
contrib.rst