Makefile 6.6 KB

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