← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/include.am

  • Committer: Olaf van der Spek
  • Date: 2011-04-20 09:27:49 UTC
  • mto: This revision was merged to the branch mainline in revision 2285.
  • Revision ID: olafvdspek@gmail.com-20110420092749-hw1q9rfj1pumc2no
Session Cache

Show diffs side-by-side

added added

removed removed

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