6. Building Sphinx Documentation¶
In order to build the documentation in the docs
directory, you will need to
have the several third-party Python packages installed, including Sphinx. To install the necessary
prerequisites, provide the optional “docs” dependencies when installing OpenMC’s
Python API. That is, from the root directory of the OpenMC repository:
python -m pip install .[docs]
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