77
90
# these are treated as phony so they'll always be rebuilt - it's pretty quick
80
94
### Documentation ###
82
# set PRETTY to get docs that look like the Bazaar web site
84
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid
86
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
96
# Default to plain documentation for maximum backwards compatibility.
97
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
101
clean-docs: clean-plain
103
html-docs: html-plain
106
### Man-page Documentation ###
108
MAN_DEPENDENCIES = bzrlib/builtins.py \
109
$(wildcard bzrlib/*.py) \
110
$(wildcard bzrlib/*/*.py) \
111
tools/generate_docs.py \
112
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
114
MAN_PAGES = man1/bzr.1
115
man1/bzr.1: $(MAN_DEPENDENCIES)
116
$(PYTHON) tools/generate_docs.py -o $@ man
119
### Sphinx-style Documentation ###
121
# Build the documentation. To keep the dependencies down to a minimum
122
# for distro packagers, we only build the html documentation by default.
123
# Sphinx 0.6 or later is preferred for the best rendering, though
124
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
125
# for installation instructions.
126
docs-sphinx: html-sphinx
128
# Clean out generated documentation
130
cd doc/en && make clean
131
cd doc/es && make clean
132
cd doc/ja && make clean
133
cd doc/ru && make clean
134
cd doc/developers && make clean
136
SPHINX_DEPENDENCIES = \
137
doc/en/release-notes/index.txt \
138
doc/en/user-reference/index.txt \
145
doc/developers/Makefile \
146
doc/developers/make.bat
148
NEWS_FILES = $(wildcard doc/en/release-notes/bzr-*.txt)
150
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
151
$(PYTHON) tools/generate_docs.py -o $@ rstx
153
doc/en/release-notes/index.txt: $(NEWS_FILES) tools/generate_release_notes.py
154
$(PYTHON) tools/generate_release_notes.py $@ $(NEWS_FILES)
156
doc/%/Makefile: doc/en/Makefile
157
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
159
doc/%/make.bat: doc/en/make.bat
160
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
162
# Build the html docs using Sphinx.
163
html-sphinx: $(SPHINX_DEPENDENCIES)
164
cd doc/en && make html
165
cd doc/es && make html
166
cd doc/ru && make html
167
cd doc/ja && make html
168
cd doc/developers && make html
170
# Build the PDF docs using Sphinx. This requires numerous LaTeX
171
# packages. See http://sphinx.pocoo.org/builders.html for details.
172
# Note: We don't currently build PDFs for the Russian docs because
173
# they require additional packages to be installed (to handle
174
# Russian hyphenation rules, etc.)
175
pdf-sphinx: $(SPHINX_DEPENDENCIES)
176
cd doc/en && make latex
177
cd doc/es && make latex
178
cd doc/ja && make latex
179
cd doc/developers && make latex
180
cd doc/en/_build/latex && make all-pdf
181
cd doc/es/_build/latex && make all-pdf
182
cd doc/developers/_build/latex && make all-pdf
184
# Build the CHM (Windows Help) docs using Sphinx.
185
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
186
# to generate the final chm files.
187
chm-sphinx: $(SPHINX_DEPENDENCIES)
188
cd doc/en && make htmlhelp
189
cd doc/es && make htmlhelp
190
cd doc/ru && make htmlhelp
191
cd doc/ja && make htmlhelp
192
cd doc/developers && make htmlhelp
195
# Build the texinfo files using Sphinx.
196
texinfo-sphinx: $(SPHINX_DEPENDENCIES)
197
cd doc/en && make texinfo
198
cd doc/es && make texinfo
199
cd doc/ru && make texinfo
200
cd doc/ja && make texinfo
201
cd doc/developers && make texinfo
203
### Documentation Website ###
205
# Where to build the website
206
DOC_WEBSITE_BUILD = build_doc_website
208
# Build and package docs into a website, complete with downloads.
209
doc-website: html-sphinx pdf-sphinx
210
$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
211
$(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
212
$(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
213
$(PYTHON) tools/package_docs.py doc/ja $(DOC_WEBSITE_BUILD)
214
$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
217
### Plain Documentation ###
219
# While Sphinx is the preferred tool for building documentation, we still
220
# support our "plain" html documentation so that Sphinx is not a hard
221
# dependency for packagers on older platforms.
223
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
89
225
# translate txt docs to html
90
derived_txt_files := \
91
doc/en/user-reference/bzr_man.txt \
226
derived_txt_files = \
92
227
doc/en/release-notes/NEWS.txt
94
229
doc/en/tutorials/tutorial.txt \
95
230
doc/en/tutorials/using_bazaar_with_launchpad.txt \
96
231
doc/en/tutorials/centralized_workflow.txt \
97
$(wildcard doc/ru/tutorials/*.txt) \
232
$(wildcard doc/es/tutorials/*.txt) \
233
$(wildcard doc/ru/tutorials/*.txt) \
234
doc/ja/tutorials/tutorial.txt \
235
doc/ja/tutorials/using_bazaar_with_launchpad.txt \
236
doc/ja/tutorials/centralized_workflow.txt \
98
237
$(wildcard doc/*/mini-tutorial/index.txt) \
99
$(wildcard doc/*/user-guide/index.txt) \
238
$(wildcard doc/*/user-guide/index-plain.txt) \
239
doc/en/admin-guide/index-plain.txt \
240
$(wildcard doc/es/guia-usario/*.txt) \
100
241
$(derived_txt_files) \
101
doc/en/developer-guide/HACKING.txt \
102
242
doc/en/upgrade-guide/index.txt \
103
$(wildcard doc/es/guia-usario/*.txt) \
104
doc/es/mini-tutorial/index.txt \
106
244
$(wildcard doc/index.*.txt)
246
doc/en/user-guide/index.txt \
247
doc/es/user-guide/index.txt \
248
doc/ja/user-guide/index.txt \
249
doc/ru/user-guide/index.txt \
250
doc/en/admin-guide/index.txt
251
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
252
htm_files = $(patsubst %.txt, %.html, $(txt_files))
108
255
doc/default.css \
109
$(wildcard doc/*/quick-reference/bzr-quick-reference.svg) \
110
$(wildcard doc/*/quick-reference/bzr-quick-reference.png) \
111
$(wildcard doc/*/quick-reference/bzr-quick-reference.pdf) \
256
$(wildcard doc/*/bzr-en-quick-reference.svg) \
257
$(wildcard doc/*/bzr-en-quick-reference.png) \
258
$(wildcard doc/*/bzr-en-quick-reference.pdf) \
259
$(wildcard doc/*/bzr-es-quick-reference.svg) \
260
$(wildcard doc/*/bzr-es-quick-reference.png) \
261
$(wildcard doc/*/bzr-es-quick-reference.pdf) \
262
$(wildcard doc/*/bzr-ru-quick-reference.svg) \
263
$(wildcard doc/*/bzr-ru-quick-reference.png) \
264
$(wildcard doc/*/bzr-ru-quick-reference.pdf) \
112
265
$(wildcard doc/*/user-guide/images/*.png)
113
htm_files := $(patsubst %.txt, %.html, $(txt_files))
115
267
# doc/developers/*.txt files that should *not* be individually
116
268
# converted to HTML
118
270
doc/developers/add.txt \
119
271
doc/developers/annotate.txt \
120
272
doc/developers/bundle-creation.txt \
122
274
doc/developers/diff.txt \
123
275
doc/developers/directory-fingerprints.txt \
124
276
doc/developers/gc.txt \
277
doc/developers/implementation-notes.txt \
125
278
doc/developers/incremental-push-pull.txt \
279
doc/developers/index.txt \
126
280
doc/developers/initial-push-pull.txt \
127
281
doc/developers/merge-scaling.txt \
282
doc/developers/miscellaneous-notes.txt \
128
283
doc/developers/missing.txt \
129
284
doc/developers/performance-roadmap-rationale.txt \
130
285
doc/developers/performance-use-case-analysis.txt \
131
286
doc/developers/planned-change-integration.txt \
132
287
doc/developers/planned-performance-changes.txt \
288
doc/developers/plans.txt \
289
doc/developers/process.txt \
133
290
doc/developers/revert.txt \
291
doc/developers/specifications.txt \
134
292
doc/developers/status.txt \
135
293
doc/developers/uncommit.txt
137
dev_txt_all := $(wildcard $(addsuffix /*.txt, doc/developers))
138
dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
139
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
141
doc/%/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/%/user-guide))
142
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
144
# Set the paper size for PDF files.
145
# Options: 'a4' (ISO A4 size), 'letter' (US Letter size)
147
# TODO: Add generation for Russian PDF
148
PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
150
# Copy and modify the RST sources, and convert SVG images to PDF
151
# files for use a images in the LaTeX-generated PDF.
152
# Then generate the PDF output from the modified RST sources.
153
doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
154
mkdir -p doc/en/user-guide/latex_prepared
155
$(PYTHON) tools/prepare_for_latex.py \
156
--out-dir=doc/en/user-guide/latex_prepared \
157
--in-dir=doc/en/user-guide
158
cd doc/en/user-guide/latex_prepared && \
159
$(PYTHON) ../../../../tools/rst2pdf.py \
160
--documentoptions=10pt,$(PAPERSIZE)paper \
161
--input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
162
--strict --title="Bazaar User Guide" \
163
index.txt ../user-guide.$(PAPERSIZE).pdf
295
dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))
296
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
297
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files))
299
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
300
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
302
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide))
303
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
305
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide))
306
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
308
doc/en/admin-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/admin-guide))
309
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
165
311
doc/developers/%.html: doc/developers/%.txt
166
312
$(rst2html) --stylesheet=../default.css $< $@
172
318
$(rst2html) --stylesheet=default.css $< $@
175
$(rst2html) --stylesheet=../../default.css $< $@
177
MAN_DEPENDENCIES = bzrlib/builtins.py \
178
$(wildcard bzrlib/*.py) \
179
$(wildcard bzrlib/*/*.py) \
180
tools/generate_docs.py \
181
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
183
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
184
$(PYTHON) tools/generate_docs.py -o $@ rstx
186
doc/en/release-notes/NEWS.txt: NEWS
187
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
189
MAN_PAGES = man1/bzr.1
190
man1/bzr.1: $(MAN_DEPENDENCIES)
191
$(PYTHON) tools/generate_docs.py -o $@ man
321
$(rst2html) --stylesheet=../../default.css $< "$@"
323
doc/en/release-notes/NEWS.txt: $(NEWS_FILES) tools/generate_release_notes.py
324
$(PYTHON) tools/generate_release_notes.py "$@" $(NEWS_FILES)
193
326
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
195
328
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
196
329
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
198
# build a png of our performance task list
200
# this is no longer built by default; you can build it if you want to look at it
201
doc/developers/performance.png: doc/developers/performance.dot
203
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
205
331
derived_web_docs = $(htm_files) $(dev_htm_files)
206
332
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
207
333
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
209
335
# the main target to build all the docs
336
docs-plain: $(ALL_DOCS)
212
338
# produce a tree containing just the final docs, ready for uploading to the web
340
html-plain: docs-plain
215
341
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
217
# Produce PDF documents. Requires pdfLaTeX, rubber, and Inkscape.
218
pdf-docs: $(PDF_DOCS)
220
343
# clean produced docs
222
345
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
223
346
$(HTMLDIR) $(derived_txt_files)
224
rm -f doc/*/user-guide/*.pdf
225
rm -rf doc/*/user-guide/latex_prepared
349
### Miscellaneous Documentation Targets ###
351
# build a png of our performance task list
352
# this is no longer built by default; you can build it if you want to look at it
353
doc/developers/performance.png: doc/developers/performance.dot
355
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
228
358
### Windows Support ###