/SQLAlchemy-0.7.8/doc/build/Makefile

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