1
# Makefile for Sphinx documentation
4
# You can set these variables from the command line.
6
SPHINXBUILD = sphinx-build
10
# DSN for the doctest database
11
PSYCOPG2_DSN="user=postgres dbname=test"
14
PAPEROPT_a4 = -D latex_paper_size=a4
15
PAPEROPT_letter = -D latex_paper_size=letter
16
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
18
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
21
@echo "Please use \`make <target>' where <target> is one of"
22
@echo " html to make standalone HTML files"
23
@echo " dirhtml to make HTML files named index.html in directories"
24
@echo " pickle to make pickle files"
25
@echo " json to make JSON files"
26
@echo " htmlhelp to make HTML files and a HTML help project"
27
@echo " qthelp to make HTML files and a qthelp project"
28
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29
@echo " changes to make an overview of all changed/added/deprecated items"
30
@echo " linkcheck to check all external links for integrity"
31
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
38
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
40
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
43
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
45
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
48
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
50
@echo "Build finished. The text pages are in $(BUILDDIR)/text."
53
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
55
@echo "Build finished; now you can process the pickle files."
58
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
60
@echo "Build finished; now you can process the JSON files."
63
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
65
@echo "Build finished; now you can run HTML Help Workshop with the" \
66
".hhp project file in $(BUILDDIR)/htmlhelp."
69
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
71
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
72
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
73
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/psycopg.qhcp"
74
@echo "To view the help file:"
75
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/psycopg.qhc"
78
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
80
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
81
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
82
"run these through (pdf)latex."
85
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
87
@echo "The overview file is in $(BUILDDIR)/changes."
90
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
92
@echo "Link check complete; look for any errors in the above output " \
93
"or in $(BUILDDIR)/linkcheck/output.txt."
96
PSYCOPG2_DSN=$(PSYCOPG2_DSN) \
97
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
98
@echo "Testing of doctests in the sources finished, look at the " \
99
"results in $(BUILDDIR)/doctest/output.txt."
added
removed
doc/src/Makefile
