6. 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:
pip install sphinx
Additionally, you will need several Sphinx extensions that can be installed directly with pip:
pip install sphinx-numfig
pip install sphinxcontrib-katex
pip install sphinxcontrib-svg2pdfconverter
6.1. Building Documentation as a Webpage¶
To build the documentation as a webpage (what appears at
https://docs.openmc.org), simply go to the docs
directory and run:
make html
6.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