Makefile 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  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 clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
  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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  32. @echo " latexpdf to make LaTeX files and run them through pdflatex"
  33. @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
  34. @echo " text to make text files"
  35. @echo " man to make manual pages"
  36. @echo " texinfo to make Texinfo files"
  37. @echo " info to make Texinfo files and run them through makeinfo"
  38. @echo " gettext to make PO message catalogs"
  39. @echo " changes to make an overview of all changed/added/deprecated items"
  40. @echo " xml to make Docutils-native XML files"
  41. @echo " pseudoxml to make pseudoxml-XML files for display purposes"
  42. @echo " linkcheck to check all external links for integrity"
  43. @echo " doctest to run all doctests embedded in the documentation (if enabled)"
  44. @echo " coverage to run coverage check of the documentation (if enabled)"
  45. clean:
  46. rm -rf $(BUILDDIR)/*
  47. html:
  48. $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  49. @echo
  50. @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  51. dirhtml:
  52. $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  53. @echo
  54. @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  55. singlehtml:
  56. $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  57. @echo
  58. @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  59. pickle:
  60. $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  61. @echo
  62. @echo "Build finished; now you can process the pickle files."
  63. json:
  64. $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  65. @echo
  66. @echo "Build finished; now you can process the JSON files."
  67. htmlhelp:
  68. $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  69. @echo
  70. @echo "Build finished; now you can run HTML Help Workshop with the" \
  71. ".hhp project file in $(BUILDDIR)/htmlhelp."
  72. qthelp:
  73. $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  74. @echo
  75. @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  76. ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  77. @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/DjangoJET.qhcp"
  78. @echo "To view the help file:"
  79. @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/DjangoJET.qhc"
  80. applehelp:
  81. $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
  82. @echo
  83. @echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
  84. @echo "N.B. You won't be able to view it unless you put it in" \
  85. "~/Library/Documentation/Help or install it in your application" \
  86. "bundle."
  87. devhelp:
  88. $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  89. @echo
  90. @echo "Build finished."
  91. @echo "To view the help file:"
  92. @echo "# mkdir -p $$HOME/.local/share/devhelp/DjangoJET"
  93. @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/DjangoJET"
  94. @echo "# devhelp"
  95. epub:
  96. $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  97. @echo
  98. @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  99. latex:
  100. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  101. @echo
  102. @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  103. @echo "Run \`make' in that directory to run these through (pdf)latex" \
  104. "(use \`make latexpdf' here to do that automatically)."
  105. latexpdf:
  106. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  107. @echo "Running LaTeX files through pdflatex..."
  108. $(MAKE) -C $(BUILDDIR)/latex all-pdf
  109. @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  110. latexpdfja:
  111. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  112. @echo "Running LaTeX files through platex and dvipdfmx..."
  113. $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
  114. @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  115. text:
  116. $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  117. @echo
  118. @echo "Build finished. The text files are in $(BUILDDIR)/text."
  119. man:
  120. $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  121. @echo
  122. @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  123. texinfo:
  124. $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  125. @echo
  126. @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
  127. @echo "Run \`make' in that directory to run these through makeinfo" \
  128. "(use \`make info' here to do that automatically)."
  129. info:
  130. $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  131. @echo "Running Texinfo files through makeinfo..."
  132. make -C $(BUILDDIR)/texinfo info
  133. @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
  134. gettext:
  135. $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  136. @echo
  137. @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
  138. changes:
  139. $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  140. @echo
  141. @echo "The overview file is in $(BUILDDIR)/changes."
  142. linkcheck:
  143. $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  144. @echo
  145. @echo "Link check complete; look for any errors in the above output " \
  146. "or in $(BUILDDIR)/linkcheck/output.txt."
  147. doctest:
  148. $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  149. @echo "Testing of doctests in the sources finished, look at the " \
  150. "results in $(BUILDDIR)/doctest/output.txt."
  151. coverage:
  152. $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
  153. @echo "Testing of coverage in the sources finished, look at the " \
  154. "results in $(BUILDDIR)/coverage/python.txt."
  155. xml:
  156. $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
  157. @echo
  158. @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
  159. pseudoxml:
  160. $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
  161. @echo
  162. @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."