← 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-10-23 00:05:28 UTC
  • Revision ID: monty@inaugust.com-20081023000528-grdvrd8c4058nutm
Moved my_handler to myisam, which is where it actually belongs.

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