docs/build-html.sh

   1 #!/bin/sh
   2 # Shell script for Sphinx documentation
   3 #
   4
   5 set -e
   6
   7 # You can set these variables from the command line.
   8 SPHINXOPTS=
   9 SPHINXBUILD=sphinx-build
  10 PAPER=
  11 BUILDDIR=_build
  12
  13 # Internal variables.
  14 case "$PAPER" in
  15     a4)
  16         PAPEROPT="-D latex_paper_size=a4"
  17         ;;
  18     letter)
  19         PAPEROPT="-D latex_paper_size=letter"
  20         ;;
  21     *)
  22         PAPEROPT=
  23         ;;
  24 esac
  25 PAPEROPT_a4="-D latex_paper_size=a4"
  26 PAPEROPT_letter="-D latex_paper_size=letter"
  27 ALLSPHINXOPTS="-d ${BUILDDIR}/doctrees ${PAPEROPT} ${SPHINXOPTS} ."
  28
  29 ${SPHINXBUILD} -b html ${ALLSPHINXOPTS} ${BUILDDIR}/html
  30 echo
  31 echo "Build finished. The HTML pages are in ${BUILDDIR}/html."