« back to all changes in this revision
Viewing changes to docs/include.am
- browse files at revision 152
- compare with another revision
- download diff
- download tarball
- view history from revision 152
- Committer: Stewart Smith
- Date: 2012-07-10 07:45:56 UTC
- Revision ID: stewart@flamingspork.com-20120710074556-0ais93w34gg6tbsi
rename doc to docs to be consistent with what pandora-plugin expects
- files renamed:
- doc/ => docs/
- files modified:
- Makefile.am
added
removed
docs/include.am
2
2
# included from Top Level Makefile.am
3
3
# All paths should be given relative to the root
4
4
5
EXTRA_DIST+= doc/make.bat \
6
doc/source/_static/percona_favicon.ico \
7
doc/source/conf.py \
8
${top_srcdir}/doc/source/*.rst \
9
${top_srcdir}/doc/source/*/*.rst \
10
${top_srcdir}/doc/source/*/*/*.rst \
11
doc/source/_static/percona_favicon.ico \
12
doc/source/_static/pp_intro.png \
13
${top_srcdir}/doc/source/percona-theme/static/*.png \
14
${top_srcdir}/doc/source/percona-theme/static/*.js \
15
${top_srcdir}/doc/source/percona-theme/static/*.css \
16
${top_srcdir}/doc/source/percona-theme/static/*.css_t \
17
${top_srcdir}/doc/source/percona-theme/*.html \
18
${top_srcdir}/doc/source/percona-theme/theme.conf \
19
doc/source/percona_favicon.ico
5
EXTRA_DIST+= docs/make.bat \
6
docs/source/_static/percona_favicon.ico \
7
docs/source/conf.py \
8
${top_srcdir}/docs/source/*.rst \
9
${top_srcdir}/docs/source/*/*.rst \
10
${top_srcdir}/docs/source/*/*/*.rst \
11
docs/source/_static/percona_favicon.ico \
12
docs/source/_static/pp_intro.png \
13
${top_srcdir}/docs/source/percona-theme/static/*.png \
14
${top_srcdir}/docs/source/percona-theme/static/*.js \
15
${top_srcdir}/docs/source/percona-theme/static/*.css \
16
${top_srcdir}/docs/source/percona-theme/static/*.css_t \
17
${top_srcdir}/docs/source/percona-theme/*.html \
18
${top_srcdir}/docs/source/percona-theme/theme.conf \
19
docs/source/percona_favicon.ico
20
20
21
21
# Makefile for Sphinx documentation
22
22
#
23
23
24
24
SPHINXOPTS = ${SPHINX_WARNINGS} -D release=${PANDORA_RELEASE_VERSION}
25
25
PAPER =
26
SPHINX_BUILDDIR = ${top_builddir}/doc/build
26
SPHINX_BUILDDIR = ${top_builddir}/docs/build
27
27
28
28
# Internal variables.
29
29
PAPEROPT_a4 = -D latex_paper_size=a4
30
30
PAPEROPT_letter = -D latex_paper_size=letter
31
ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/doc/source
31
ALLSPHINXOPTS = -d $(SPHINX_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) ${top_srcdir}/docs/source
32
32
33
33
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest doc sphinx-docs
34
34
58
58
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
59
59
60
60
html-local:
61
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
61
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/html
62
62
@echo
63
63
@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/html."
64
64
65
65
dirhtml:
66
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
66
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/dirhtml
67
67
@echo
68
68
@echo "Build finished. The HTML pages are in $(SPHINX_BUILDDIR)/dirhtml."
69
69
70
70
singlehtml:
71
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
71
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/singlehtml
72
72
@echo
73
73
@echo "Build finished. The HTML page is in $(SPHINX_BUILDDIR)/singlehtml."
74
74
75
75
pickle:
76
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
76
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/pickle
77
77
@echo
78
78
@echo "Build finished; now you can process the pickle files."
79
79
80
80
json:
81
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
81
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/json
82
82
@echo
83
83
@echo "Build finished; now you can process the JSON files."
84
84
85
85
htmlhelp:
86
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
86
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/htmlhelp
87
87
@echo
88
88
@echo "Build finished; now you can run HTML Help Workshop with the" \
89
89
".hhp project file in $(SPHINX_BUILDDIR)/htmlhelp."
90
90
91
91
qthelp:
92
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
92
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/qthelp
93
93
@echo
94
94
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
95
95
".qhcp project file in $(SPHINX_BUILDDIR)/qthelp, like this:"
98
98
@echo "# assistant -collectionFile $(SPHINX_BUILDDIR)/qthelp/Drizzle.qhc"
99
99
100
100
devhelp:
101
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
101
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/devhelp
102
102
@echo
103
103
@echo "Build finished."
104
104
@echo "To view the help file:"
107
107
@echo "# devhelp"
108
108
109
109
epub:
110
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
110
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/epub
111
111
@echo
112
112
@echo "Build finished. The epub file is in $(SPHINX_BUILDDIR)/epub."
113
113
114
114
latex:
115
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
115
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
116
116
@echo
117
117
@echo "Build finished; the LaTeX files are in $(SPHINX_BUILDDIR)/latex."
118
118
@echo "Run \`make' in that directory to run these through (pdf)latex" \
119
119
"(use \`make latexpdf' here to do that automatically)."
120
120
121
121
latexpdf: latex
122
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
122
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/latex
123
123
@echo "Running LaTeX files through pdflatex..."
124
124
make -C $(SPHINX_BUILDDIR)/latex all-pdf
125
125
@echo "pdflatex finished; the PDF files are in $(SPHINX_BUILDDIR)/latex."
126
126
127
127
text:
128
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
128
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/text
129
129
@echo
130
130
@echo "Build finished. The text files are in $(SPHINX_BUILDDIR)/text."
131
131
132
132
man:
133
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
133
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/man
134
134
@echo
135
135
@echo "Build finished. The manual pages are in $(SPHINX_BUILDDIR)/man."
136
136
137
137
changes:
138
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
138
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/changes
139
139
@echo
140
140
@echo "The overview file is in $(SPHINX_BUILDDIR)/changes."
141
141
142
142
linkcheck:
143
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
143
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/linkcheck
144
144
@echo
145
145
@echo "Link check complete; look for any errors in the above output " \
146
146
"or in $(SPHINX_BUILDDIR)/linkcheck/output.txt."
147
147
148
148
doctest:
149
PYTHONPATH=${top_srcdir}/doc $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
149
PYTHONPATH=${top_srcdir}/docs $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(SPHINX_BUILDDIR)/doctest
150
150
@echo "Testing of doctests in the sources finished, look at the " \
151
151
"results in $(SPHINX_BUILDDIR)/doctest/output.txt."
152
152
else
Loggerhead is a web-based interface for Breezy
Version: 2.0.1