9. Generating Sphinx DocumentationΒΆ
This documentation is generated using sphinx
, supported formats are HTML and TeX/LaTeX (in PDF). sphinx
and its dependencies can be installed using spack-stack
and the environment spec jedi-tools-env
(see Section 4). Note that in order to generate TeX/LaTeX documentation, a TeX/LaTeX distribution is required as an external package (see Section 5.1.5), and the jedi-tools-env
environment spec must be built with the variant +latex
.
Steps to generate the documentation locally:
If using a
spack-stack
environment, load the required modules (e.g.module load jedi-tools-env
), otherwise make sure thatsphinx``is loaded, ``sphinxcontrib-bibtex
and your TeX/LaTeX distribution of choice are optionally loaded into your environment. The latter two are only required if building the TeX/LaTeX documentation.Execute the following commands (note that the default value for option
SPHINX_OUTPUT_HTML
isON
, and for optionSPHINX_OUTPUT_LATEX
isOFF
):
cd doc
mkdir build
cd build
cmake [-DSPHINX_OUTPUT_HTML=OFF] [-DSPHINX_OUTPUT_LATEX=ON] ..
make
The output can be found in subdirectories
html
(open html/index.html
) andpdf
(openpdf/spack-stack.pdf
).
Note
If updates to the documentation source files in doc/source
are made, rerunning make
updates the HTML documentation, but not the TeX/LaTeX documentation. To update the latter, run make clean
followed by make
.