Makefile 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. # Makefile for Sphinx documentation
  2. #
  3. # You can set these variables from the command line.
  4. SPHINXOPTS =
  5. SPHINXBUILD = PYTHONPATH=../:$(PYTHONPATH) sphinx-build
  6. PAPER =
  7. # Internal variables.
  8. PAPEROPT_a4 = -D latex_paper_size=a4
  9. PAPEROPT_letter = -D latex_paper_size=letter
  10. ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  11. .PHONY: help clean text html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
  12. help:
  13. @echo "Please use \`make <target>' where <target> is one of"
  14. @echo " text to make text files"
  15. @echo " html to make standalone HTML files"
  16. @echo " dirhtml to make HTML files named index.html in directories"
  17. @echo " pickle to make pickle files"
  18. @echo " json to make JSON files"
  19. @echo " htmlhelp to make HTML files and a HTML help project"
  20. @echo " qthelp to make HTML files and a qthelp project"
  21. @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  22. @echo " changes to make an overview of all changed/added/deprecated items"
  23. @echo " linkcheck to check all external links for integrity"
  24. @echo " doctest to run all doctests embedded in the documentation (if enabled)"
  25. @echo " coverage to generate a docstring coverage report"
  26. clean:
  27. -rm -rf _build/*
  28. text:
  29. $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) _build/text
  30. @echo
  31. @echo "Build finished. The text files are in _build/text."
  32. html:
  33. $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
  34. @echo
  35. @echo "Build finished. The HTML pages are in _build/html."
  36. dirhtml:
  37. $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
  38. @echo
  39. @echo "Build finished. The HTML pages are in _build/dirhtml."
  40. pickle:
  41. $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
  42. @echo
  43. @echo "Build finished; now you can process the pickle files."
  44. json:
  45. $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
  46. @echo
  47. @echo "Build finished; now you can process the JSON files."
  48. htmlhelp:
  49. $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
  50. @echo
  51. @echo "Build finished; now you can run HTML Help Workshop with the" \
  52. ".hhp project file in _build/htmlhelp."
  53. qthelp:
  54. $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
  55. @echo
  56. @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  57. ".qhcp project file in _build/qthelp, like this:"
  58. @echo "# qcollectiongenerator _build/qthelp/Eventlet.qhcp"
  59. @echo "To view the help file:"
  60. @echo "# assistant -collectionFile _build/qthelp/Eventlet.qhc"
  61. latex:
  62. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
  63. @echo
  64. @echo "Build finished; the LaTeX files are in _build/latex."
  65. @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  66. "run these through (pdf)latex."
  67. changes:
  68. $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
  69. @echo
  70. @echo "The overview file is in _build/changes."
  71. linkcheck:
  72. $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
  73. @echo
  74. @echo "Link check complete; look for any errors in the above output " \
  75. "or in _build/linkcheck/output.txt."
  76. doctest:
  77. $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
  78. @echo "Testing of doctests in the sources finished, look at the " \
  79. "results in _build/doctest/output.txt."
  80. coverage:
  81. $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) _build/coverage
  82. @echo "Coverage report finished, look at the " \
  83. "results in _build/coverage/python.txt."