Makefile 5.4 KB

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