← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/include.am

  • Committer: Brian Aker
  • Date: 2008-07-20 05:41:52 UTC
  • Revision ID: brian@tangent.org-20080720054152-5laf6plsb0o7h6ss
Documentation cleanup

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