5. 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
5.1. Building Documentation as a Webpage¶
To build the documentation as a webpage (what appears at
http://mit-crpg.github.io/openmc), simply go to the docs
directory and run:
make html
5.2. Building Documentation as a PDF¶
To build PDF documentation, you will need to have a LaTeX distribution installed on your computer as well as Inkscape, which is used to convert .svg files to .pdf files. Inkscape can be installed in a Debian-derivative with:
sudo apt-get install inkscape
One the pre-requisites are installed, simply go to the docs
directory and
run:
make latexpdf