doc/Makefile

   1 # Makefile for Sphinx documentation
   2 #
   3
   4 # You can set these variables from the command line.
   5 SPHINXOPTS    =
   6 SPHINXBUILD   = sphinx-build
   7 PAPER         =
   8
   9 # Internal variables.
  10 PAPEROPT_a4     = -D latex_paper_size=a4
  11 PAPEROPT_letter = -D latex_paper_size=letter
  12 ALLSPHINXOPTS   = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
  13
  14 .PHONY: help clean html web pickle htmlhelp latex changes linkcheck
  15
  16 help:
  17         @echo "Please use \`make <target>' where <target> is one of"
  18         @echo "  html      to make standalone HTML files"
  19         @echo "  pickle    to make pickle files (usable by e.g. sphinx-web)"
  20         @echo "  htmlhelp  to make HTML files and a HTML help project"
  21         @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  22         @echo "  changes   to make an overview over all changed/added/deprecated items"
  23         @echo "  linkcheck to check all external links for integrity"
  24
  25 clean:
  26         -rm -rf build/*
  27
  28 generate:
  29         ./sphinxext/autosummary_generate.py -o source/generated source/*.rst
  30
  31 html:
  32         mkdir -p build/html build/doctrees
  33         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
  34         @echo
  35         @echo "Build finished. The HTML pages are in build/html."
  36
  37 pickle:
  38         mkdir -p build/pickle build/doctrees
  39         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
  40         @echo
  41         @echo "Build finished; now you can process the pickle files or run"
  42         @echo "  sphinx-web build/pickle"
  43         @echo "to start the sphinx-web server."
  44
  45 web: pickle
  46
  47 htmlhelp:
  48         mkdir -p build/htmlhelp build/doctrees
  49         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
  50         @echo
  51         @echo "Build finished; now you can run HTML Help Workshop with the" \
  52               ".hhp project file in build/htmlhelp."
  53
  54 latex:
  55         mkdir -p build/latex build/doctrees
  56         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
  57         @echo
  58         @echo "Build finished; the LaTeX files are in build/latex."
  59         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  60               "run these through (pdf)latex."
  61
  62 changes:
  63         mkdir -p build/changes build/doctrees
  64         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
  65         @echo
  66         @echo "The overview file is in build/changes."
  67
  68 linkcheck:
  69         mkdir -p build/linkcheck build/doctrees
  70         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
  71         @echo
  72         @echo "Link check complete; look for any errors in the above output " \
  73               "or in build/linkcheck/output.txt."