Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.29 KB

File metadata and controls

37 lines (24 loc) · 1.29 KB

Build Instructions

If you wish to contribute to this project this document describes (briefly) how to re-generate the HTML pages from the .rst (reStructuredText) source.

The HTML is generated using Sphinx which in turn uses Docutils, the Jinja2 templating engine and 'make'. On my Ubuntu system I installed the dependencies with:

sudo apt-get install python3-sphinx docutils-doc python-pil-doc python3-pil-dbg sphinx-doc build-essential

Some texlive dependencies will also be required in order to make the 'latexpdf' build target work:

sudo apt-get install texlive-latex-recommended texlive-latex-extra

If you're not using a Debian/Ubuntu system, refer to those projects for manual installation instructions.

The Sphinx site includes a reStructuredText Primer which should help you get up to speed with the markup.

To generate the HTML, run the command:

make html

You can then view the resulting generated files under build/html.

The PDF and EPUB formats are both very rough. The formatter doesn't handle the links to static files so different build options are required:

SPHINXOPTS="-a" make -e latexpdf
SPHINXOPTS="-a" make -e epub