Building the Documentation¶
Sphinx¶
The documentation in this project is generated by Sphinx from reStructuredTex.
Ubuntu/Debian¶
This project started on Ubuntu Linux 18.04. That doesn’t mean you can’t use another distribution, or even another operating system, but you may need to perform some additional setup steps to get your builds working. (If you do get it working under another system, please consider adding an article to let others know how you did it!)
Prerequisites¶
The project uses the Sphinx LatexBuilder to generate a PDF document. If you’re using Ubuntu (or Debian) you’ll need to install texlive and latexmk.
sudo apt-get install texlive-latex-recommended \
texlive-latex-extra \
texlive-fonts-recommended \
latexmk