← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/include.am

  • Committer: Mark Atwood
  • Date: 2011-08-11 03:05:03 UTC
  • mfrom: (2385.1.12 refactor4)
  • Revision ID: me@mark.atwood.name-20110811030503-rp9xjihc5x3y0x4q
merge lp:~olafvdspek/drizzle/refactor4

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