Building the Documentation

Sphinx

The documentation in this project is generated by Sphinx from reStructuredTex.

Ubuntu/Debian

This project started with Debian 11. This does not mean that you cannot use another distribution, or even another operating system, but you may need to perform additional setup steps to make your builds work.

Prerequisites

You need to install sphinx dependancy using the Makefile file.

make install_docs

The project uses the Sphinx LatexBuilder to generate a PDF document. If you are using Debian you will need to install texlive and latexmk.

sudo apt-get install texlive-latex-recommended \
    texlive-latex-extra \
    texlive-fonts-recommended \
    latexmk

make

Once everything is in place, you can build the documentation using the make docs the target defined in the project’s Makefile.

make docs