Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 931 Bytes

README.md

File metadata and controls

38 lines (25 loc) · 931 Bytes

JuMP.jl Documentation README

JuMP.jl's documentation is written in reStructuredText, a good reference for which is the Documenting Python chapter of the Python Developer's Guide.

Building the documentation

The documentation is built using Sphinx and LaTeX. On ubuntu, you'll need the following packages installed:

python-sphinx
texlive
texlive-latex-extra

To install the required Sphinx theme, run:

$ pip install sphinx_rtd_theme

Then run

$ make helpdb.jl
$ make html
$ make latexpdf

File layout

conf.py             Sphinx configuration
helpdb.jl           REPL help database
sphinx/             Sphinx extensions and plugins
sphinx/jlhelp.py    Sphinx plugin to build helpdb.jl
_themes/            Sphinx html themes