/doc/Makefile

https://bitbucket.org/tortoisehg/hgtk/ · Makefile · 97 lines · 76 code · 17 blank · 4 comment · 2 complexity · 21200da336e4144c7808f3177fe9b65c 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. QCOLLECTIONGENERATOR = qcollectiongenerator
  8. # Internal variables.
  9. PAPEROPT_a4 = -D latex_paper_size=a4
  10. PAPEROPT_letter = -D latex_paper_size=letter
  11. ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
  12. .PHONY: help clean html web pickle htmlhelp qthelp qhc latex changes linkcheck
  13. help:
  14. @echo "Please use \`make <target>' where <target> is one of"
  15. @echo " html to make standalone HTML files"
  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 " qhc to make QHC file"
  21. @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  22. @echo " changes to make an overview over all changed/added/deprecated items"
  23. @echo " linkcheck to check all external links for integrity"
  24. clean:
  25. -rm -rf build/*
  26. html:
  27. mkdir -p build/html build/doctrees
  28. $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
  29. @echo
  30. @echo "Build finished. The HTML pages are in build/html."
  31. zip: html
  32. (cd build ; zip TortoiseHg.html.zip -r html)
  33. pickle:
  34. mkdir -p build/pickle build/doctrees
  35. $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
  36. @echo
  37. @echo "Build finished; now you can process the pickle files."
  38. web: pickle
  39. json:
  40. mkdir -p build/json build/doctrees
  41. $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
  42. @echo
  43. @echo "Build finished; now you can process the JSON files."
  44. htmlhelp:
  45. mkdir -p build/htmlhelp build/doctrees
  46. $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
  47. @echo
  48. @echo "Build finished; now you can run HTML Help Workshop with the" \
  49. ".hhp project file in build/htmlhelp."
  50. qthelp:
  51. mkdir -p build/qthelp build/doctrees
  52. $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
  53. @echo
  54. @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  55. ".qhcp project file in build/qthelp, like this:"
  56. @echo "# qcollectiongenerator build/qthelp/foo.qhcp"
  57. @echo "To view the help file:"
  58. @echo "# assistant -collectionFile build/qthelp/foo.qhc"
  59. qhc: qthelp
  60. $(QCOLLECTIONGENERATOR) build/qthelp/TortoiseHg.qhcp
  61. @echo "Build finished. To view the help file:"
  62. @echo "# assistant -collectionFile build/qthelp/TortoiseHg.qhc"
  63. latex:
  64. mkdir -p build/latex build/doctrees
  65. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
  66. @echo
  67. @echo "Build finished; the LaTeX files are in build/latex."
  68. @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
  69. "run these through (pdf)latex."
  70. changes:
  71. mkdir -p build/changes build/doctrees
  72. $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
  73. @echo
  74. @echo "The overview file is in build/changes."
  75. linkcheck:
  76. mkdir -p build/linkcheck build/doctrees
  77. $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
  78. @echo
  79. @echo "Link check complete; look for any errors in the above output " \
  80. "or in build/linkcheck/output.txt."