doc/Makefile.sphinx

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