docs/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) .
  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"
  20         @echo "  json      to make JSON files"
  21         @echo "  htmlhelp  to make HTML files and a HTML help project"
  22         @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  23         @echo "  changes   to make an overview over all changed/added/deprecated items"
  24         @echo "  linkcheck to check all external links for integrity"
  25
  26 clean:
  27         -rm -rf _build/*
  28
  29 html:
  30         mkdir -p _build/html _build/doctrees
  31         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
  32         @echo
  33         @echo "Build finished. The HTML pages are in _build/html."
  34
  35 pickle:
  36         mkdir -p _build/pickle _build/doctrees
  37         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
  38         @echo
  39         @echo "Build finished; now you can process the pickle files"
  40
  41 json:
  42         mkdir -p _build/json _build/doctrees
  43         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
  44         @echo
  45         @echo "Build finished; now you can process the json files"
  46
  47 web: pickle
  48
  49 htmlhelp:
  50         mkdir -p _build/htmlhelp _build/doctrees
  51         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
  52         @echo
  53         @echo "Build finished; now you can run HTML Help Workshop with the" \
  54               ".hhp project file in _build/htmlhelp."
  55
  56 latex:
  57         mkdir -p _build/latex _build/doctrees
  58         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
  59         @echo
  60         @echo "Build finished; the LaTeX files are in _build/latex."
  61         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  62               "run these through (pdf)latex."
  63
  64 changes:
  65         mkdir -p _build/changes _build/doctrees
  66         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
  67         @echo
  68         @echo "The overview file is in _build/changes."
  69
  70 linkcheck:
  71         mkdir -p _build/linkcheck _build/doctrees
  72         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
  73         @echo
  74         @echo "Link check complete; look for any errors in the above output " \
  75               "or in _build/linkcheck/output.txt."