4. Building Sphinx Documentation

In order to build the documentation in the docs directory, you will need to have the Sphinx third-party Python package. The easiest way to install Sphinx is via pip:

sudo pip install sphinx

Additionally, you will also need a Sphinx extension for numbering figures. The Numfig package can be installed directly with pip:

sudo pip install sphinx-numfig

4.1. Building Documentation as a Webpage

To build the documentation as a webpage (what appears at http://openmc.readthedocs.io), simply go to the docs directory and run:

make html

4.2. Building Documentation as a PDF

To build PDF documentation, you will need to have a LaTeX distribution installed on your computer. Once you have a LaTeX distribution installed, simply go to the docs directory and run:

make latexpdf