/doc/Makefile

https://code.google.com/p/ruffus/ · Makefile · 96 lines · 74 code · 17 blank · 5 comment · 2 complexity · 22778d9e7218814e75f2ea513eae131d 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 dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
  12. help:
  13. @echo "Please use \`make <target>' where <target> is one of"
  14. @echo " html to make standalone HTML files"
  15. @echo " dirhtml to make HTML files named index.html in directories"
  16. @echo " pickle to make pickle files"
  17. @echo " json to make JSON files"
  18. @echo " htmlhelp to make HTML files and a HTML help project"
  19. @echo " qthelp to make HTML files and a qthelp project"
  20. @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  21. @echo " changes to make an overview of all changed/added/deprecated items"
  22. @echo " linkcheck to check all external links for integrity"
  23. @echo " doctest to run all doctests embedded in the documentation (if enabled)"
  24. clean:
  25. -rm -rf _build/*
  26. html:
  27. $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
  28. @echo
  29. rsync -t --recursive _build/html/* /home/lg/public_html/oss/ruffus
  30. #../../ruffus_docs_sync.cmd
  31. @echo "Build finished. The HTML pages are in _build/html."
  32. dirhtml:
  33. $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
  34. @echo
  35. @echo "Build finished. The HTML pages are in _build/dirhtml."
  36. pickle:
  37. $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
  38. @echo
  39. @echo "Build finished; now you can process the pickle files."
  40. json:
  41. $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
  42. @echo
  43. @echo "Build finished; now you can process the JSON files."
  44. htmlhelp:
  45. $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
  46. @echo
  47. @echo "Build finished; now you can run HTML Help Workshop with the" \
  48. ".hhp project file in _build/htmlhelp."
  49. qthelp:
  50. $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
  51. @echo
  52. @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  53. ".qhcp project file in _build/qthelp, like this:"
  54. @echo "# qcollectiongenerator _build/qthelp/pypeline.qhcp"
  55. @echo "To view the help file:"
  56. @echo "# assistant -collectionFile _build/qthelp/pypeline.qhc"
  57. latex:
  58. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
  59. @echo
  60. @echo "Build finished; the LaTeX files are in _build/latex."
  61. @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  62. "run these through (pdf)latex."
  63. changes:
  64. $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
  65. @echo
  66. @echo "The overview file is in _build/changes."
  67. linkcheck:
  68. $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
  69. @echo
  70. @echo "Link check complete; look for any errors in the above output " \
  71. "or in _build/linkcheck/output.txt."
  72. doctest:
  73. $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
  74. @echo "Testing of doctests in the sources finished, look at the " \
  75. "results in _build/doctest/output.txt."
  76. pdf:
  77. $(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) _build/pdf
  78. @echo
  79. @echo "Build finished. The PDF files are in _build/pdf."