doc/Makefile.am

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