Documentation/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 SPHINXAUTOBUILD   = sphinx-autobuild
   8 PAPER             =
   9 BUILDDIR          = _build
  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) .
  15 # the i18n builder cannot share the environment and doctrees with the others
  16 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  17
  18 .PHONY: help
  19 help:
  20         @echo "Please use \`make <target>' where <target> is one of"
  21         @echo "  html       to make standalone HTML files"
  22         @echo "  dirhtml    to make HTML files named index.html in directories"
  23         @echo "  singlehtml to make a single large HTML file"
  24         @echo "  pickle     to make pickle files"
  25         @echo "  json       to make JSON files"
  26         @echo "  htmlhelp   to make HTML files and a HTML help project"
  27         @echo "  qthelp     to make HTML files and a qthelp project"
  28         @echo "  applehelp  to make an Apple Help Book"
  29         @echo "  devhelp    to make HTML files and a Devhelp project"
  30         @echo "  epub       to make an epub"
  31         @echo "  epub3      to make an epub3"
  32         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  33         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
  34         @echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
  35         @echo "  text       to make text files"
  36         @echo "  man        to make manual pages"
  37         @echo "  texinfo    to make Texinfo files"
  38         @echo "  info       to make Texinfo files and run them through makeinfo"
  39         @echo "  gettext    to make PO message catalogs"
  40         @echo "  changes    to make an overview of all changed/added/deprecated items"
  41         @echo "  xml        to make Docutils-native XML files"
  42         @echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
  43         @echo "  linkcheck  to check all external links for integrity"
  44         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
  45         @echo "  coverage   to run coverage check of the documentation (if enabled)"
  46         @echo "  dummy      to check syntax errors of document sources"
  47
  48 .PHONY: clean
  49 clean:
  50         rm -rf $(BUILDDIR)
  51
  52 .PHONY: html
  53 html:
  54         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  55         @echo
  56         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  57
  58 .PHONY: livehtml
  59 livehtml:
  60         @echo "Starting sphinx-autobuild. The HTML pages are in $(BUILDDIR)."
  61         @echo "Press Ctrl-C to stop."
  62         @echo
  63         $(SPHINXAUTOBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
  64
  65 .PHONY: dirhtml
  66 dirhtml:
  67         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  68         @echo
  69         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  70
  71 .PHONY: singlehtml
  72 singlehtml:
  73         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  74         @echo
  75         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  76
  77 .PHONY: pickle
  78 pickle:
  79         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  80         @echo
  81         @echo "Build finished; now you can process the pickle files."
  82
  83 .PHONY: json
  84 json:
  85         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  86         @echo
  87         @echo "Build finished; now you can process the JSON files."
  88
  89 .PHONY: htmlhelp
  90 htmlhelp:
  91         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  92         @echo
  93         @echo "Build finished; now you can run HTML Help Workshop with the" \
  94               ".hhp project file in $(BUILDDIR)/htmlhelp."
  95
  96 .PHONY: qthelp
  97 qthelp:
  98         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  99         @echo
 100         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
 101               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 102         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/coreboot.qhcp"
 103         @echo "To view the help file:"
 104         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/coreboot.qhc"
 105
 106 .PHONY: applehelp
 107 applehelp:
 108         $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
 109         @echo
 110         @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
 111         @echo "N.B. You won't be able to view it unless you put it in" \
 112               "~/Library/Documentation/Help or install it in your application" \
 113               "bundle."
 114
 115 .PHONY: devhelp
 116 devhelp:
 117         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 118         @echo
 119         @echo "Build finished."
 120         @echo "To view the help file:"
 121         @echo "# mkdir -p $$HOME/.local/share/devhelp/coreboot"
 122         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/coreboot"
 123         @echo "# devhelp"
 124
 125 .PHONY: epub
 126 epub:
 127         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 128         @echo
 129         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 130
 131 .PHONY: epub3
 132 epub3:
 133         $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
 134         @echo
 135         @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
 136
 137 .PHONY: latex
 138 latex:
 139         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 140         @echo
 141         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 142         @echo "Run \`make' in that directory to run these through (pdf)latex" \
 143               "(use \`make latexpdf' here to do that automatically)."
 144
 145 .PHONY: latexpdf
 146 latexpdf:
 147         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 148         @echo "Running LaTeX files through pdflatex..."
 149         $(MAKE) -C $(BUILDDIR)/latex all-pdf
 150         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 151
 152 .PHONY: latexpdfja
 153 latexpdfja:
 154         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 155         @echo "Running LaTeX files through platex and dvipdfmx..."
 156         $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
 157         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 158
 159 .PHONY: text
 160 text:
 161         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 162         @echo
 163         @echo "Build finished. The text files are in $(BUILDDIR)/text."
 164
 165 .PHONY: man
 166 man:
 167         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 168         @echo
 169         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 170
 171 .PHONY: texinfo
 172 texinfo:
 173         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 174         @echo
 175         @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
 176         @echo "Run \`make' in that directory to run these through makeinfo" \
 177               "(use \`make info' here to do that automatically)."
 178
 179 .PHONY: info
 180 info:
 181         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
 182         @echo "Running Texinfo files through makeinfo..."
 183         make -C $(BUILDDIR)/texinfo info
 184         @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
 185
 186 .PHONY: gettext
 187 gettext:
 188         $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
 189         @echo
 190         @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
 191
 192 .PHONY: changes
 193 changes:
 194         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 195         @echo
 196         @echo "The overview file is in $(BUILDDIR)/changes."
 197
 198 .PHONY: linkcheck
 199 linkcheck:
 200         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 201         @echo
 202         @echo "Link check complete; look for any errors in the above output " \
 203               "or in $(BUILDDIR)/linkcheck/output.txt."
 204
 205 .PHONY: doctest
 206 doctest:
 207         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 208         @echo "Testing of doctests in the sources finished, look at the " \
 209               "results in $(BUILDDIR)/doctest/output.txt."
 210
 211 .PHONY: coverage
 212 coverage:
 213         $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
 214         @echo "Testing of coverage in the sources finished, look at the " \
 215               "results in $(BUILDDIR)/coverage/python.txt."
 216
 217 .PHONY: xml
 218 xml:
 219         $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
 220         @echo
 221         @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
 222
 223 .PHONY: pseudoxml
 224 pseudoxml:
 225         $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 226         @echo
 227         @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
 228
 229 .PHONY: dummy
 230 dummy:
 231         $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
 232         @echo
 233         @echo "Build finished. Dummy builder generates no files."