Makefile 6.1 KB

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