1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
# vim:ft=automake
# included from Top Level Makefile.am
# All paths should be given relative to the root
EXTRA_DIST+= \
docs/_static \
docs/_templates \
docs/conf.py \
docs/Doxyfile \
docs/drizzled_header.html \
docs/logo.png \
docs/plugins/list.rst \
docs/pyext/__init__.py \
docs/pyext/options.py \
docs/pyext/confval.py \
docs/pyext/dbtable.py \
docs/_static/drizzle.ico \
${top_srcdir}/docs/*.rst \
${top_srcdir}/docs/clients/*.rst \
${top_srcdir}/docs/contributing/*.rst \
${top_srcdir}/docs/libdrizzle/*.rst \
${top_srcdir}/docs/installing/*.rst \
${top_srcdir}/docs/testing/*.rst
# Makefile for Sphinx documentation
#
SPHINXOPTS = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
PAPER =
SPHINX_BUILDDIR = ${top_builddir}/docs
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest doxygen
doxygen:
${DOXYGEN} docs/Doxyfile
if HAVE_RECENT_SPHINX
man_MANS+= \
docs/man/drizzledump.1 \
docs/man/drizzleadmin.1
DISTCLEANFILES+= \
docs/man/drizzledump.1 \
docs/man/drizzleadmin.1
docs/man/drizzledump.1: man
docs/man/drizzleadmin.1: man
endif
if HAVE_SPHINX
sphinx-help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
html-local:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
dirhtml:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
singlehtml:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
pickle:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
qthelp:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhc"
devhelp:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Drizzle"
@echo "# ln -s $(SPHINX_BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Drizzle"
@echo "# devhelp"
epub:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
latex:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf: latex
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
make -C $(SPHINX_BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
text:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
man:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
changes:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
@echo
@echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
linkcheck:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
doctest:
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(SPHINX_BUILDDIR)/doctest/output.txt."
endif
|