/doc/Makefile

https://bitbucket.org/jpellerin/nose/ · Makefile · 89 lines · 70 code · 15 blank · 4 comment · 2 complexity · 09d751b433c71d5f7ad4019e8871f1ec 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. # 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 html web pickle htmlhelp latex changes linkcheck man readme
  12. help:
  13. @echo "Please use \`make <target>' where <target> is one of"
  14. @echo " html to make standalone HTML files"
  15. @echo " pickle to make pickle files"
  16. @echo " json to make JSON files"
  17. @echo " htmlhelp to make HTML files and a HTML help project"
  18. @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  19. @echo " changes to make an overview over all changed/added/deprecated items"
  20. @echo " linkcheck to check all external links for integrity"
  21. clean:
  22. -rm -rf .build/*
  23. html:
  24. mkdir -p .build/html .build/doctrees
  25. $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) .build/html
  26. @echo
  27. @echo "Build finished. The HTML pages are in .build/html."
  28. pickle:
  29. mkdir -p .build/pickle .build/doctrees
  30. $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .build/pickle
  31. @echo
  32. @echo "Build finished; now you can process the pickle files."
  33. web: pickle
  34. json:
  35. mkdir -p .build/json .build/doctrees
  36. $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) .build/json
  37. @echo
  38. @echo "Build finished; now you can process the JSON files."
  39. htmlhelp:
  40. mkdir -p .build/htmlhelp .build/doctrees
  41. $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .build/htmlhelp
  42. @echo
  43. @echo "Build finished; now you can run HTML Help Workshop with the" \
  44. ".hhp project file in .build/htmlhelp."
  45. latex:
  46. mkdir -p .build/latex .build/doctrees
  47. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .build/latex
  48. @echo
  49. @echo "Build finished; the LaTeX files are in .build/latex."
  50. @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  51. "run these through (pdf)latex."
  52. changes:
  53. mkdir -p .build/changes .build/doctrees
  54. $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .build/changes
  55. @echo
  56. @echo "The overview file is in .build/changes."
  57. linkcheck:
  58. mkdir -p .build/linkcheck .build/doctrees
  59. $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .build/linkcheck
  60. @echo
  61. @echo "Link check complete; look for any errors in the above output " \
  62. "or in .build/linkcheck/output.txt."
  63. man:
  64. mkdir -p .build/man ./build/doctrees
  65. $(SPHINXBUILD) -b manpage $(ALLSPHINXOPTS) .build/man man.rst
  66. cp .build/man/man.man ../nosetests.1
  67. @echo
  68. @echo "Generated man page copied to ../nosetests.1"
  69. readme:
  70. mkdir -p .build/text .build/doctrees$
  71. $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) .build/text usage.rst
  72. cp .build/text/usage.txt ../README.txt
  73. @echo
  74. @echo "Updated ../README.txt"