/docs/Makefile

https://bitbucket.org/neithere/argh/ · Makefile · 118 lines · 95 code · 19 blank · 4 comment · 2 complexity · 094c592e14533f72de16db1d8d5782ca MD5 · raw file

  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. .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp epub latex changes linkcheck doctest
  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 " changes to make an overview of all changed/added/deprecated items"
  27. @echo " linkcheck to check all external links for integrity"
  28. @echo " doctest to run all doctests embedded in the documentation (if enabled)"
  29. clean:
  30. -rm -rf $(BUILDDIR)/*
  31. html:
  32. $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  33. @echo
  34. @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  35. dirhtml:
  36. $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  37. @echo
  38. @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  39. singlehtml:
  40. $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  41. @echo
  42. @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  43. pickle:
  44. $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  45. @echo
  46. @echo "Build finished; now you can process the pickle files."
  47. json:
  48. $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  49. @echo
  50. @echo "Build finished; now you can process the JSON files."
  51. htmlhelp:
  52. $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  53. @echo
  54. @echo "Build finished; now you can run HTML Help Workshop with the" \
  55. ".hhp project file in $(BUILDDIR)/htmlhelp."
  56. qthelp:
  57. $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  58. @echo
  59. @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  60. ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  61. @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/argh.qhcp"
  62. @echo "To view the help file:"
  63. @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/argh.qhc"
  64. devhelp:
  65. $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
  66. @echo
  67. @echo "Build finished."
  68. @echo "To view the help file:"
  69. @echo "# mkdir -p $$HOME/.local/share/devhelp/argh"
  70. @echo "# ln -s _build/devhelp $$HOME/.local/share/devhelp/argh"
  71. @echo "# devhelp"
  72. epub:
  73. $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  74. @echo
  75. @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  76. latex:
  77. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  78. @echo
  79. @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  80. @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  81. "run these through (pdf)latex."
  82. latexpdf: latex
  83. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
  84. @echo "Running LaTeX files through pdflatex..."
  85. make -C _build/latex all-pdf
  86. @echo "pdflatex finished; the PDF files are in _build/latex."
  87. changes:
  88. $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  89. @echo
  90. @echo "The overview file is in $(BUILDDIR)/changes."
  91. linkcheck:
  92. $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  93. @echo
  94. @echo "Link check complete; look for any errors in the above output " \
  95. "or in $(BUILDDIR)/linkcheck/output.txt."
  96. doctest:
  97. $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  98. @echo "Testing of doctests in the sources finished, look at the " \
  99. "results in $(BUILDDIR)/doctest/output.txt."