doc/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
  10 # User-friendly check for sphinx-build
  11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
  12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
  13 endif
  14
  15 # Internal variables.
  16 PAPEROPT_a4     = -D latex_paper_size=a4
  17 PAPEROPT_letter = -D latex_paper_size=letter
  18 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
  19 # the i18n builder cannot share the environment and doctrees with the others
  20 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
  21
  22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
  23
  24 help:
  25         @echo "Please use \`make <target>' where <target> is one of"
  26         @echo "  html       to make standalone HTML files"
  27         @echo "  dirhtml    to make HTML files named index.html in directories"
  28         @echo "  singlehtml to make a single large HTML file"
  29         @echo "  pickle     to make pickle files"
  30         @echo "  json       to make JSON files"
  31         @echo "  htmlhelp   to make HTML files and a HTML help project"
  32         @echo "  qthelp     to make HTML files and a qthelp project"
  33         @echo "  applehelp  to make an Apple Help Book"
  34         @echo "  devhelp    to make HTML files and a Devhelp project"
  35         @echo "  epub       to make an epub"
  36         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  37         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
  38         @echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
  39         @echo "  text       to make text files"
  40         @echo "  man        to make manual pages"
  41         @echo "  texinfo    to make Texinfo files"
  42         @echo "  info       to make Texinfo files and run them through makeinfo"
  43         @echo "  gettext    to make PO message catalogs"
  44         @echo "  changes    to make an overview of all changed/added/deprecated items"
  45         @echo "  xml        to make Docutils-native XML files"
  46         @echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
  47         @echo "  linkcheck  to check all external links for integrity"
  48         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
  49
  50 clean:
  51         rm -rf $(BUILDDIR)/*
  52
  53 html:
  54         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  55         @echo
  56         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  57
  58 dirhtml:
  59         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  60         @echo
  61         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  62
  63 singlehtml:
  64         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  65         @echo
  66         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  67
  68 pickle:
  69         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  70         @echo
  71         @echo "Build finished; now you can process the pickle files."
  72
  73 json:
  74         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  75         @echo
  76         @echo "Build finished; now you can process the JSON files."
  77
  78 htmlhelp:
  79         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  80         @echo
  81         @echo "Build finished; now you can run HTML Help Workshop with the" \
  82               ".hhp project file in $(BUILDDIR)/htmlhelp."
  83
  84 qthelp:
  85         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  86         @echo
  87         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  88               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  89         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/derp.qhcp"
  90         @echo "To view the help file:"
  91         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/derp.qhc"
  92
  93 applehelp:
  94         $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
  95         @echo
  96         @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
  97         @echo "N.B. You won't be able to view it unless you put it in" \
  98               "~/Library/Documentation/Help or install it in your application" \
  99               "bundle."
 100
 101 devhelp:
 102         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 103         @echo
 104         @echo "Build finished."
 105         @echo "To view the help file:"
 106         @echo "# mkdir -p $$HOME/.local/share/devhelp/derp"
 107         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/derp"
 108         @echo "# devhelp"
 109
 110 epub:
 111         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 112         @echo
 113         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 114
 115 latex:
 116         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 117         @echo
 118         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 119         @echo "Run \`make' in that directory to run these through (pdf)latex" \
 120               "(use \`make latexpdf' here to do that automatically)."
 121
 122 latexpdf:
 123         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 124         @echo "Running LaTeX files through pdflatex..."
 125         $(MAKE) -C $(BUILDDIR)/latex all-pdf
 126         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 127
 128 latexpdfja:
 129         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 130         @echo "Running LaTeX files through platex and dvipdfmx..."
 131         $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
 132         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 133
 134 text:
 135         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 136         @echo
 137         @echo "Build finished. The text files are in $(BUILDDIR)/text."
 138
 139 man:
 140         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 141         @echo
 142         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 143
 144 texinfo:
 145         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 146         @echo
 147         @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
 148         @echo "Run \`make' in that directory to run these through makeinfo" \
 149               "(use \`make info' here to do that automatically)."
 150
 151 info:
 152         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 153         @echo "Running Texinfo files through makeinfo..."
 154         make -C $(BUILDDIR)/texinfo info
 155         @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
 156
 157 gettext:
 158         $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
 159         @echo
 160         @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
 161
 162 changes:
 163         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 164         @echo
 165         @echo "The overview file is in $(BUILDDIR)/changes."
 166
 167 linkcheck:
 168         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 169         @echo
 170         @echo "Link check complete; look for any errors in the above output " \
 171               "or in $(BUILDDIR)/linkcheck/output.txt."
 172
 173 doctest:
 174         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 175         @echo "Testing of doctests in the sources finished, look at the " \
 176               "results in $(BUILDDIR)/doctest/output.txt."
 177
 178 xml:
 179         $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
 180         @echo
 181         @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
 182
 183 pseudoxml:
 184         $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 185         @echo
 186         @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."