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 dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
  15
  16 all: pdf
  17
  18 pdf: latex
  19         @$(MAKE) -C build/latex all-pdf
  20
  21 help:
  22         @echo "Please use \`make <target>' where <target> is one of"
  23         @echo "  html      to make standalone HTML files"
  24         @echo "  dirhtml   to make HTML files named index.html in directories"
  25         @echo "  pickle    to make pickle files"
  26         @echo "  json      to make JSON files"
  27         @echo "  htmlhelp  to make HTML files and a HTML help project"
  28         @echo "  qthelp    to make HTML files and a qthelp project"
  29         @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  30         @echo "  changes   to make an overview of all changed/added/deprecated items"
  31         @echo "  linkcheck to check all external links for integrity"
  32         @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
  33
  34 clean:
  35         -rm -rf build/*
  36
  37 html:
  38         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
  39         @echo
  40         @echo "Build finished. The HTML pages are in build/html."
  41
  42 dirhtml:
  43         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml
  44         @echo
  45         @echo "Build finished. The HTML pages are in build/dirhtml."
  46
  47 pickle:
  48         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
  49         @echo
  50         @echo "Build finished; now you can process the pickle files."
  51
  52 json:
  53         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
  54         @echo
  55         @echo "Build finished; now you can process the JSON files."
  56
  57 htmlhelp:
  58         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
  59         @echo
  60         @echo "Build finished; now you can run HTML Help Workshop with the" \
  61               ".hhp project file in build/htmlhelp."
  62
  63 qthelp:
  64         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
  65         @echo
  66         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  67               ".qhcp project file in build/qthelp, like this:"
  68         @echo "# qcollectiongenerator build/qthelp/tesis.qhcp"
  69         @echo "To view the help file:"
  70         @echo "# assistant -collectionFile build/qthelp/tesis.qhc"
  71
  72 latex:
  73         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
  74         @echo
  75         @echo "Build finished; the LaTeX files are in build/latex."
  76         @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  77               "run these through (pdf)latex."
  78
  79 changes:
  80         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
  81         @echo
  82         @echo "The overview file is in build/changes."
  83
  84 linkcheck:
  85         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
  86         @echo
  87         @echo "Link check complete; look for any errors in the above output " \
  88               "or in build/linkcheck/output.txt."
  89
  90 doctest:
  91         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest
  92         @echo "Testing of doctests in the sources finished, look at the " \
  93               "results in build/doctest/output.txt."