Requirements

• Sphinx version 1.5 or later: http://sphinx-doc.org/contents.html
• LaTeX (and pdflatex, and various LaTeX packages)

On Debian and Ubuntu

# apt-get install python-sphinx texlive texlive-latex-extra libalgorithm-diff-perl \
                  texlive-humanities texlive-generic-recommended texlive-generic-extra \
                  latexmk

If the version of python-sphinx installed is too old, then an additional new version can be installed with the Python package installer:

$ apt-get install python-pip
$ pip install --user --upgrade Sphinx
$ export SPHINXBUILD=~/.local/bin/sphinx-build

Export SPHINXBUILD (see above) if Sphinx was installed with pip --user, then follow Make commands below

On Fedora

# dnf install python2-sphinx texlive texlive-capt-of texlive-draftwatermark \
              texlive-fncychap texlive-framed texlive-needspace \
              texlive-tabulary texlive-titlesec texlive-upquote \
              texlive-wrapfig

It is also possible to use python3-sphinx; this requires SPHINXBUILD=sphinx-build-3 to be passed on the Make command line.

On Mac OS X

• Install MacTeX

• Install pip if you do not have it:

  $ sudo easy_install pip
  

• Install Sphinx:

  $ pip install --user --upgrade Sphinx
  

Make Targets

To generate PDF:

$ make latexpdf

To generate hierarchy of HTML pages:

$ make html

To generate a single HTML page:

$ make singlehtml

Output goes in ./build subdirectory.