← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/include.am

  • Committer: Monty Taylor
  • Date: 2011-02-13 17:26:39 UTC
  • mfrom: (2157.2.2 give-in-to-pkg-config)
  • mto: This revision was merged to the branch mainline in revision 2166.
  • Revision ID: mordred@inaugust.com-20110213172639-nhy7i72sfhoq13ms
Merged in pkg-config fixes.

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