You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Makefile 7.6KB

3 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  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) source
  12. # the i18n builder cannot share the environment and doctrees with the others
  13. I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
  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: livehtml
  52. livehtml:
  53. sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  54. .PHONY: dirhtml
  55. dirhtml:
  56. $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  57. @echo
  58. @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  59. .PHONY: singlehtml
  60. singlehtml:
  61. $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  62. @echo
  63. @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  64. .PHONY: pickle
  65. pickle:
  66. $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  67. @echo
  68. @echo "Build finished; now you can process the pickle files."
  69. .PHONY: json
  70. json:
  71. $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  72. @echo
  73. @echo "Build finished; now you can process the JSON files."
  74. .PHONY: htmlhelp
  75. htmlhelp:
  76. $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  77. @echo
  78. @echo "Build finished; now you can run HTML Help Workshop with the" \
  79. ".hhp project file in $(BUILDDIR)/htmlhelp."
  80. .PHONY: qthelp
  81. qthelp:
  82. $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  83. @echo
  84. @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  85. ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  86. @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/NeuroRTArchway.qhcp"
  87. @echo "To view the help file:"
  88. @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/NeuroRTArchway.qhc"
  89. .PHONY: applehelp
  90. applehelp:
  91. $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
  92. @echo
  93. @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
  94. @echo "N.B. You won't be able to view it unless you put it in" \
  95. "~/Library/Documentation/Help or install it in your application" \
  96. "bundle."
  97. .PHONY: devhelp
  98. devhelp:
  99. $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  100. @echo
  101. @echo "Build finished."
  102. @echo "To view the help file:"
  103. @echo "# mkdir -p $$HOME/.local/share/devhelp/NeuroRTArchway"
  104. @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/NeuroRTArchway"
  105. @echo "# devhelp"
  106. .PHONY: epub
  107. epub:
  108. $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  109. @echo
  110. @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  111. .PHONY: epub3
  112. epub3:
  113. $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
  114. @echo
  115. @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
  116. .PHONY: latex
  117. latex:
  118. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  119. @echo
  120. @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  121. @echo "Run \`make' in that directory to run these through (pdf)latex" \
  122. "(use \`make latexpdf' here to do that automatically)."
  123. .PHONY: latexpdf
  124. latexpdf:
  125. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  126. @echo "Running LaTeX files through pdflatex..."
  127. $(MAKE) -C $(BUILDDIR)/latex all-pdf
  128. @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  129. .PHONY: latexpdfja
  130. latexpdfja:
  131. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  132. @echo "Running LaTeX files through platex and dvipdfmx..."
  133. $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
  134. @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  135. .PHONY: text
  136. text:
  137. $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  138. @echo
  139. @echo "Build finished. The text files are in $(BUILDDIR)/text."
  140. .PHONY: man
  141. man:
  142. $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  143. @echo
  144. @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  145. .PHONY: texinfo
  146. texinfo:
  147. $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  148. @echo
  149. @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
  150. @echo "Run \`make' in that directory to run these through makeinfo" \
  151. "(use \`make info' here to do that automatically)."
  152. .PHONY: info
  153. info:
  154. $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  155. @echo "Running Texinfo files through makeinfo..."
  156. make -C $(BUILDDIR)/texinfo info
  157. @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
  158. .PHONY: gettext
  159. gettext:
  160. $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  161. @echo
  162. @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
  163. .PHONY: changes
  164. changes:
  165. $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  166. @echo
  167. @echo "The overview file is in $(BUILDDIR)/changes."
  168. .PHONY: linkcheck
  169. linkcheck:
  170. $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  171. @echo
  172. @echo "Link check complete; look for any errors in the above output " \
  173. "or in $(BUILDDIR)/linkcheck/output.txt."
  174. .PHONY: doctest
  175. doctest:
  176. $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  177. @echo "Testing of doctests in the sources finished, look at the " \
  178. "results in $(BUILDDIR)/doctest/output.txt."
  179. .PHONY: coverage
  180. coverage:
  181. $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
  182. @echo "Testing of coverage in the sources finished, look at the " \
  183. "results in $(BUILDDIR)/coverage/python.txt."
  184. .PHONY: xml
  185. xml:
  186. $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
  187. @echo
  188. @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
  189. .PHONY: pseudoxml
  190. pseudoxml:
  191. $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
  192. @echo
  193. @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
  194. .PHONY: dummy
  195. dummy:
  196. $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
  197. @echo
  198. @echo "Build finished. Dummy builder generates no files."