← 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: 2008-11-16 05:36:13 UTC
  • mto: (584.1.9 devel)
  • mto: This revision was merged to the branch mainline in revision 589.
  • Revision ID: monty@inaugust.com-20081116053613-bld4rqxhlkb49c02
Split out cache_row and type_holder.

Show diffs side-by-side

added added

removed removed

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