Makefile 5.3 KB

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