PageRenderTime 45ms CodeModel.GetById 15ms RepoModel.GetById 0ms app.codeStats 0ms

/SQLAlchemy-0.7.8/doc/build/Makefile

#
Makefile | 146 lines | 118 code | 23 blank | 5 comment | 2 complexity | d75d087446beff12099c7ebdbc14c3b5 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. BUILDDIR = output
  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. # the i18n builder cannot share the environment and doctrees with the others
  13. I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
  14. .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest dist-html site-mako gettext
  15. help:
  16. @echo "Please use \`make <target>' where <target> is one of"
  17. @echo " html to make standalone HTML files"
  18. @echo " gettext to make PO message catalogs"
  19. @echo " dist-html same as html, but places files in /doc"
  20. @echo " dirhtml to make HTML files named index.html in directories"
  21. @echo " singlehtml to make a single large HTML file"
  22. @echo " pickle to make pickle files"
  23. @echo " json to make JSON files"
  24. @echo " htmlhelp to make HTML files and a HTML help project"
  25. @echo " qthelp to make HTML files and a qthelp project"
  26. @echo " devhelp to make HTML files and a Devhelp project"
  27. @echo " epub to make an epub"
  28. @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  29. @echo " latexpdf to make LaTeX files and run them through pdflatex"
  30. @echo " text to make text files"
  31. @echo " man to make manual pages"
  32. @echo " changes to make an overview of all changed/added/deprecated items"
  33. @echo " linkcheck to check all external links for integrity"
  34. @echo " doctest to run all doctests embedded in the documentation (if enabled)"
  35. clean:
  36. -rm -rf $(BUILDDIR)/*
  37. html:
  38. $(SPHINXBUILD) -b html -A mako_layout=html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  39. @echo
  40. @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  41. gettext:
  42. $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  43. @echo
  44. @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
  45. dist-html:
  46. $(SPHINXBUILD) -b html -A mako_layout=html $(ALLSPHINXOPTS) ..
  47. @echo
  48. @echo "Build finished. The HTML pages are in ../."
  49. dirhtml:
  50. $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  51. @echo
  52. @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  53. singlehtml:
  54. $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  55. @echo
  56. @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  57. pickle:
  58. $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  59. @echo
  60. @echo "Build finished; now you can process the pickle files."
  61. json:
  62. $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  63. @echo
  64. @echo "Build finished; now you can process the JSON files."
  65. htmlhelp:
  66. $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  67. @echo
  68. @echo "Build finished; now you can run HTML Help Workshop with the" \
  69. ".hhp project file in $(BUILDDIR)/htmlhelp."
  70. qthelp:
  71. $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  72. @echo
  73. @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  74. ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  75. @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/SQLAlchemy.qhcp"
  76. @echo "To view the help file:"
  77. @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SQLAlchemy.qhc"
  78. devhelp:
  79. $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  80. @echo
  81. @echo "Build finished."
  82. @echo "To view the help file:"
  83. @echo "# mkdir -p $$HOME/.local/share/devhelp/SQLAlchemy"
  84. @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SQLAlchemy"
  85. @echo "# devhelp"
  86. epub:
  87. $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  88. @echo
  89. @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  90. latex:
  91. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  92. cp texinputs/* $(BUILDDIR)/latex/
  93. @echo
  94. @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  95. @echo "Run \`make' in that directory to run these through (pdf)latex" \
  96. "(use \`make latexpdf' here to do that automatically)."
  97. latexpdf:
  98. $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  99. cp texinputs/* $(BUILDDIR)/latex/
  100. @echo "Running LaTeX files through pdflatex..."
  101. make -C $(BUILDDIR)/latex all-pdf
  102. @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  103. text:
  104. $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  105. @echo
  106. @echo "Build finished. The text files are in $(BUILDDIR)/text."
  107. man:
  108. $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  109. @echo
  110. @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  111. changes:
  112. $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  113. @echo
  114. @echo "The overview file is in $(BUILDDIR)/changes."
  115. linkcheck:
  116. $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  117. @echo
  118. @echo "Link check complete; look for any errors in the above output " \
  119. "or in $(BUILDDIR)/linkcheck/output.txt."
  120. doctest:
  121. $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) .
  122. @echo "Testing of doctests in the sources finished, look at the " \
  123. "results in $(BUILDDIR)/doctest/output.txt."