PageRenderTime 39ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/Makefile

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