Makefile 7.6 KB

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