pyomo/doc/OnlineDocs at main · deluair/pyomo · GitHub

Name		Name	Last commit message	Last commit date
parent directory ..
_static		_static
advanced_topics		advanced_topics
contributed_packages		contributed_packages
developer_reference		developer_reference
library_reference		library_reference
model_debugging		model_debugging
model_transformations		model_transformations
modeling_extensions		modeling_extensions
pyomo_modeling_components		pyomo_modeling_components
pyomo_overview		pyomo_overview
src		src
working_abstractmodels		working_abstractmodels
Makefile		Makefile
README.md		README.md
bibliography.rst		bibliography.rst
citing_pyomo.rst		citing_pyomo.rst
conf.py		conf.py
contribution_guide.rst		contribution_guide.rst
docutils.conf		docutils.conf
errors.rst		errors.rst
index.rst		index.rst
installation.rst		installation.rst
make.bat		make.bat
related_packages.rst		related_packages.rst
solving_pyomo_models.rst		solving_pyomo_models.rst
tutorial_examples.rst		tutorial_examples.rst
working_models.rst		working_models.rst

README.md

Preview Changes Locally

Install Sphinx
```
$ pip install sphinx sphinx_rtd_theme sphinx_copybutton
```
NOTE: You may get a warning about the dot command if you do not have graphviz installed.

Build the documentation

$ make html      # Option 1
$ make latexpdf  # Option 2

View _build/html/index.html in your browser

Test Changes Locally

$ make -C doc/OnlineDocs doctest -d      # from the pyomo root folder