Makefile 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  1. # Makefile for Sphinx documentation
  2. #
  3. # You can set these variables from the command line.
  4. SPHINXOPTS =
  5. ifndef SPHINXBUILD
  6. SPHINXBUILD = ../bin/sphinx-build
  7. endif
  8. PAPER =
  9. BUILDDIR = _build
  10. # Internal variables.
  11. PAPEROPT_a4 = -D latex_paper_size=a4
  12. PAPEROPT_letter = -D latex_paper_size=letter
  13. ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  14. # the i18n builder cannot share the environment and doctrees with the others
  15. I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  16. .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
  17. help:
  18. @echo "Please use \`make <target>' where <target> is one of"
  19. @echo " html to make standalone HTML files"
  20. @echo " dirhtml to make HTML files named index.html in directories"
  21. @echo " singlehtml to make a single large HTML file"
  22. @echo " pickle to make pickle files"
  23. @echo " json to make JSON files"
  24. @echo " htmlhelp to make HTML files and a HTML help project"
  25. @echo " qthelp to make HTML files and a qthelp project"
  26. @echo " devhelp to make HTML files and a Devhelp project"
  27. @echo " epub to make an epub"
  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 " text to make text files"
  31. @echo " man to make manual pages"
  32. @echo " texinfo to make Texinfo files"
  33. @echo " info to make Texinfo files and run them through makeinfo"
  34. @echo " gettext to make PO message catalogs"
  35. @echo " changes to make an overview of all changed/added/deprecated items"
  36. @echo " linkcheck to check all external links for integrity"
  37. @echo " doctest to run all doctests embedded in the documentation (if enabled)"
  38. clean:
  39. -rm -rf $(BUILDDIR)/*
  40. html:
  41. $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  42. @echo
  43. @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  44. dirhtml:
  45. $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  46. @echo
  47. @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  48. singlehtml:
  49. $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  50. @echo
  51. @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  52. pickle:
  53. $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  54. @echo
  55. @echo "Build finished; now you can process the pickle files."
  56. json:
  57. $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  58. @echo
  59. @echo "Build finished; now you can process the JSON files."
  60. htmlhelp:
  61. $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  62. @echo
  63. @echo "Build finished; now you can run HTML Help Workshop with the" \
  64. ".hhp project file in $(BUILDDIR)/htmlhelp."
  65. qthelp:
  66. $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  67. @echo
  68. @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  69. ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  70. @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pytest-django.qhcp"
  71. @echo "To view the help file:"
  72. @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pytest-django.qhc"
  73. devhelp:
  74. $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  75. @echo
  76. @echo "Build finished."
  77. @echo "To view the help file:"
  78. @echo "# mkdir -p $$HOME/.local/share/devhelp/pytest-django"
  79. @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pytest-django"
  80. @echo "# devhelp"
  81. epub:
  82. $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  83. @echo
  84. @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  85. latex:
  86. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  87. @echo
  88. @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  89. @echo "Run \`make' in that directory to run these through (pdf)latex" \
  90. "(use \`make latexpdf' here to do that automatically)."
  91. latexpdf:
  92. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  93. @echo "Running LaTeX files through pdflatex..."
  94. $(MAKE) -C $(BUILDDIR)/latex all-pdf
  95. @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  96. text:
  97. $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  98. @echo
  99. @echo "Build finished. The text files are in $(BUILDDIR)/text."
  100. man:
  101. $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  102. @echo
  103. @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  104. texinfo:
  105. $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  106. @echo
  107. @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
  108. @echo "Run \`make' in that directory to run these through makeinfo" \
  109. "(use \`make info' here to do that automatically)."
  110. info:
  111. $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  112. @echo "Running Texinfo files through makeinfo..."
  113. make -C $(BUILDDIR)/texinfo info
  114. @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
  115. gettext:
  116. $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  117. @echo
  118. @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
  119. changes:
  120. $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  121. @echo
  122. @echo "The overview file is in $(BUILDDIR)/changes."
  123. linkcheck:
  124. $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  125. @echo
  126. @echo "Link check complete; look for any errors in the above output " \
  127. "or in $(BUILDDIR)/linkcheck/output.txt."
  128. doctest:
  129. $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  130. @echo "Testing of doctests in the sources finished, look at the " \
  131. "results in $(BUILDDIR)/doctest/output.txt."