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