← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/include.am

Merge Monty - Added inter-plugin dependencies for controlling plugin load order

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