summaryrefslogtreecommitdiff
path: root/docs/build-html.sh
diff options
context:
space:
mode:
Diffstat (limited to 'docs/build-html.sh')
-rwxr-xr-xdocs/build-html.sh31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/build-html.sh b/docs/build-html.sh
new file mode 100755
index 000000000..ea02aa02b
--- /dev/null
+++ b/docs/build-html.sh
@@ -0,0 +1,31 @@
+#!/bin/sh
+# Shell script for Sphinx documentation
+#
+
+set -e
+
+# You can set these variables from the command line.
+SPHINXOPTS=
+SPHINXBUILD=sphinx-build
+PAPER=
+BUILDDIR=_build
+
+# Internal variables.
+case "$PAPER" in
+ a4)
+ PAPEROPT="-D latex_paper_size=a4"
+ ;;
+ letter)
+ PAPEROPT="-D latex_paper_size=letter"
+ ;;
+ *)
+ PAPEROPT=
+ ;;
+esac
+PAPEROPT_a4="-D latex_paper_size=a4"
+PAPEROPT_letter="-D latex_paper_size=letter"
+ALLSPHINXOPTS="-d ${BUILDDIR}/doctrees ${PAPEROPT} ${SPHINXOPTS} ."
+
+${SPHINXBUILD} -b html ${ALLSPHINXOPTS} ${BUILDDIR}/html
+echo
+echo "Build finished. The HTML pages are in ${BUILDDIR}/html."