« back to all changes in this revision
Viewing changes to doc/Makefile
- browse files at revision 449
- compare with another revision
- download diff
- download tarball
- view history from revision 449
- Committer: Stewart Smith
- Date: 2012-07-31 04:46:23 UTC
- mfrom: (242.55.9 staging-1.6)
- Revision ID: stewart@flamingspork.com-20120731044623-kystli3yf9tpp1s4
merge from 1.6: Bug #1021954: XtraBackup on MultiInstance server connects to default instance for slave info
- files added:
- doc/Makefile
- doc/source/percona-theme
- doc/source/percona-theme/static
- files removed:
- doc/Makefile
- files modified:
- .bzrignore
added
removed
doc/Makefile
1
# Makefile for Sphinx documentation
2
#
3
4
# You can set these variables from the command line.
5
SPHINXOPTS =
6
SPHINXBUILD = sphinx-build
7
PAPER =
8
BUILDDIR = build
9
10
# Internal variables.
11
PAPEROPT_a4 = -D latex_paper_size=a4
12
PAPEROPT_letter = -D latex_paper_size=letter
13
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14
15
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
16
17
help:
18
@echo "Please use \`make <target>' where <target> is one of"
19
@echo " html to make standalone HTML files"
20
@echo " dirhtml to make HTML files named index.html in directories"
21
@echo " singlehtml to make a single large HTML file"
22
@echo " pickle to make pickle files"
23
@echo " json to make JSON files"
24
@echo " htmlhelp to make HTML files and a HTML help project"
25
@echo " qthelp to make HTML files and a qthelp project"
26
@echo " devhelp to make HTML files and a Devhelp project"
27
@echo " epub to make an epub"
28
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29
@echo " latexpdf to make LaTeX files and run them through pdflatex"
30
@echo " text to make text files"
31
@echo " man to make manual pages"
32
@echo " changes to make an overview of all changed/added/deprecated items"
33
@echo " linkcheck to check all external links for integrity"
34
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
35
36
clean:
37
-rm -rf $(BUILDDIR)/*
38
39
html:
40
@echo "Downloading percona-theme ..."
41
@wget -O percona-theme.tar.gz --http-user=dev --http-password=dev http://percona.com/docs/theme/percona-xtrabackup
42
@echo "Extracting theme."
43
@tar -zxf percona-theme.tar.gz
44
@rm -rf source/percona-theme
45
@mv percona-theme source/percona-theme
46
@rm percona-theme.tar.gz
47
@echo "Building html doc"
48
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
49
@echo
50
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
51
52
dirhtml:
53
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
54
@echo
55
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
56
57
singlehtml:
58
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
59
@echo
60
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
61
62
pickle:
63
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
64
@echo
65
@echo "Build finished; now you can process the pickle files."
66
67
json:
68
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
69
@echo
70
@echo "Build finished; now you can process the JSON files."
71
72
htmlhelp:
73
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
74
@echo
75
@echo "Build finished; now you can run HTML Help Workshop with the" \
76
".hhp project file in $(BUILDDIR)/htmlhelp."
77
78
qthelp:
79
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
80
@echo
81
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
82
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
83
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PerconaXtraBackup.qhcp"
84
@echo "To view the help file:"
85
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PerconaXtraBackup.qhc"
86
87
devhelp:
88
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
89
@echo
90
@echo "Build finished."
91
@echo "To view the help file:"
92
@echo "# mkdir -p $$HOME/.local/share/devhelp/PerconaXtraBackup"
93
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PerconaXtraBackup"
94
@echo "# devhelp"
95
96
epub:
97
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
98
@echo
99
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
100
101
latex:
102
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
103
@echo
104
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
105
@echo "Run \`make' in that directory to run these through (pdf)latex" \
106
"(use \`make latexpdf' here to do that automatically)."
107
108
latexpdf:
109
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
110
@echo "Running LaTeX files through pdflatex..."
111
make -C $(BUILDDIR)/latex all-pdf
112
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
113
114
text:
115
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
116
@echo
117
@echo "Build finished. The text files are in $(BUILDDIR)/text."
118
119
man:
120
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
121
@echo
122
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
123
124
changes:
125
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
126
@echo
127
@echo "The overview file is in $(BUILDDIR)/changes."
128
129
linkcheck:
130
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
131
@echo
132
@echo "Link check complete; look for any errors in the above output " \
133
"or in $(BUILDDIR)/linkcheck/output.txt."
134
135
doctest:
136
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
137
@echo "Testing of doctests in the sources finished, look at the " \
138
"results in $(BUILDDIR)/doctest/output.txt."
Loggerhead is a web-based interface for Breezy
Version: 2.0.1