Makefile 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  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. # User-friendly check for sphinx-build
  9. ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
  10. $(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/)
  11. endif
  12. # Internal variables.
  13. PAPEROPT_a4 = -D latex_paper_size=a4
  14. PAPEROPT_letter = -D latex_paper_size=letter
  15. ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  16. # the i18n builder cannot share the environment and doctrees with the others
  17. I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  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 " apicheck to verify that all modules are present in autodoc"
  47. @echo " configcheck to verify that all modules are present in autodoc"
  48. @echo " spelling to perform a spell check"
  49. .PHONY: clean
  50. clean:
  51. rm -rf $(BUILDDIR)/*
  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. .PHONY: dirhtml
  58. dirhtml:
  59. $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  60. @echo
  61. @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  62. .PHONY: singlehtml
  63. singlehtml:
  64. $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  65. @echo
  66. @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  67. .PHONY: pickle
  68. pickle:
  69. $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  70. @echo
  71. @echo "Build finished; now you can process the pickle files."
  72. .PHONY: json
  73. json:
  74. $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  75. @echo
  76. @echo "Build finished; now you can process the JSON files."
  77. .PHONY: htmlhelp
  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. .PHONY: qthelp
  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/PROJ.qhcp"
  90. @echo "To view the help file:"
  91. @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PROJ.qhc"
  92. .PHONY: applehelp
  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. .PHONY: devhelp
  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/PROJ"
  107. @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PROJ"
  108. @echo "# devhelp"
  109. .PHONY: epub
  110. epub:
  111. $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  112. @echo
  113. @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  114. .PHONY: epub3
  115. epub3:
  116. $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
  117. @echo
  118. @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
  119. .PHONY: latex
  120. latex:
  121. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  122. @echo
  123. @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  124. @echo "Run \`make' in that directory to run these through (pdf)latex" \
  125. "(use \`make latexpdf' here to do that automatically)."
  126. .PHONY: latexpdf
  127. latexpdf:
  128. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  129. @echo "Running LaTeX files through pdflatex..."
  130. $(MAKE) -C $(BUILDDIR)/latex all-pdf
  131. @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  132. .PHONY: latexpdfja
  133. latexpdfja:
  134. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  135. @echo "Running LaTeX files through platex and dvipdfmx..."
  136. $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
  137. @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  138. .PHONY: text
  139. text:
  140. $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  141. @echo
  142. @echo "Build finished. The text files are in $(BUILDDIR)/text."
  143. .PHONY: man
  144. man:
  145. $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  146. @echo
  147. @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  148. .PHONY: texinfo
  149. texinfo:
  150. $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  151. @echo
  152. @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
  153. @echo "Run \`make' in that directory to run these through makeinfo" \
  154. "(use \`make info' here to do that automatically)."
  155. .PHONY: info
  156. info:
  157. $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  158. @echo "Running Texinfo files through makeinfo..."
  159. make -C $(BUILDDIR)/texinfo info
  160. @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
  161. .PHONY: gettext
  162. gettext:
  163. $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  164. @echo
  165. @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
  166. .PHONY: changes
  167. changes:
  168. $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  169. @echo
  170. @echo "The overview file is in $(BUILDDIR)/changes."
  171. .PHONY: linkcheck
  172. linkcheck:
  173. $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  174. @echo
  175. @echo "Link check complete; look for any errors in the above output " \
  176. "or in $(BUILDDIR)/linkcheck/output.txt."
  177. .PHONY: doctest
  178. doctest:
  179. $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  180. @echo "Testing of doctests in the sources finished, look at the " \
  181. "results in $(BUILDDIR)/doctest/output.txt."
  182. .PHONY: coverage
  183. coverage:
  184. $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
  185. @echo "Testing of coverage in the sources finished, look at the " \
  186. "results in $(BUILDDIR)/coverage/python.txt."
  187. .PHONY: apicheck
  188. apicheck:
  189. $(SPHINXBUILD) -b apicheck $(ALLSPHINXOPTS) $(BUILDDIR)/apicheck
  190. .PHONY: configcheck
  191. configcheck:
  192. $(SPHINXBUILD) -b configcheck $(ALLSPHINXOPTS) $(BUILDDIR)/configcheck
  193. .PHONY: spelling
  194. spelling:
  195. SPELLCHECK=1 $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
  196. .PHONY: xml
  197. xml:
  198. $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
  199. @echo
  200. @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
  201. .PHONY: pseudoxml
  202. pseudoxml:
  203. $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
  204. @echo
  205. @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."