doc/Makefile.am

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