70
90
# these are treated as phony so they'll always be rebuilt - it's pretty quick
73
94
### Documentation ###
75
# set PRETTY to get docs that look like the Bazaar web site
77
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid
79
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
LANGUAGE=C $(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
82
225
# translate txt docs to html
83
derived_txt_files := \
84
doc/en/user-reference/bzr_man.txt \
85
doc/en/developer-guide/HACKING.txt \
226
derived_txt_files = \
86
227
doc/en/release-notes/NEWS.txt
87
txt_files := $(wildcard doc/en/tutorials/*.txt) \
229
doc/en/tutorials/tutorial.txt \
230
doc/en/tutorials/using_bazaar_with_launchpad.txt \
231
doc/en/tutorials/centralized_workflow.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 \
237
$(wildcard doc/*/mini-tutorial/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) \
88
241
$(derived_txt_files) \
242
doc/en/upgrade-guide/index.txt \
244
$(wildcard doc/index.*.txt)
89
246
doc/en/user-guide/index.txt \
90
doc/en/mini-tutorial/index.txt \
91
$(wildcard doc/es/guia-usario/*.txt) \
92
doc/es/mini-tutorial/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))
97
doc/en/quick-reference/quick-start-summary.svg \
98
doc/en/quick-reference/quick-start-summary.png \
99
doc/en/quick-reference/quick-start-summary.pdf \
100
$(wildcard doc/en/user-guide/images/*.png) \
101
doc/es/referencia-rapida/referencia-rapida.svg \
102
doc/es/referencia-rapida/referencia-rapida.png \
103
doc/es/referencia-rapida/referencia-rapida.pdf \
104
$(wildcard doc/es/guia-usuario/images/*.png)
105
htm_files := $(patsubst %.txt, %.html, $(txt_files))
106
dev_txt_files := $(wildcard $(addsuffix /*.txt, doc/developers))
107
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
109
doc/en/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
110
$(rst2html) --stylesheet=../../default.css doc/en/user-guide/index.txt $@
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) \
265
$(wildcard doc/*/user-guide/images/*.png)
267
# doc/developers/*.txt files that should *not* be individually
270
doc/developers/add.txt \
271
doc/developers/annotate.txt \
272
doc/developers/bundle-creation.txt \
273
doc/developers/commit.txt \
274
doc/developers/diff.txt \
275
doc/developers/directory-fingerprints.txt \
276
doc/developers/gc.txt \
277
doc/developers/implementation-notes.txt \
278
doc/developers/incremental-push-pull.txt \
279
doc/developers/index.txt \
280
doc/developers/initial-push-pull.txt \
281
doc/developers/merge-scaling.txt \
282
doc/developers/miscellaneous-notes.txt \
283
doc/developers/missing.txt \
284
doc/developers/performance-roadmap-rationale.txt \
285
doc/developers/performance-use-case-analysis.txt \
286
doc/developers/planned-change-integration.txt \
287
doc/developers/planned-performance-changes.txt \
288
doc/developers/plans.txt \
289
doc/developers/process.txt \
290
doc/developers/revert.txt \
291
doc/developers/specifications.txt \
292
doc/developers/status.txt \
293
doc/developers/uncommit.txt
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 $@
112
311
doc/developers/%.html: doc/developers/%.txt
113
312
$(rst2html) --stylesheet=../default.css $< $@
115
314
doc/index.html: doc/index.txt
116
315
$(rst2html) --stylesheet=default.css $< $@
317
doc/index.%.html: doc/index.%.txt
318
$(rst2html) --stylesheet=default.css $< $@
119
$(rst2html) --stylesheet=../../default.css $< $@
121
MAN_DEPENDENCIES = bzrlib/builtins.py \
122
bzrlib/bundle/commands.py \
123
bzrlib/conflicts.py \
124
bzrlib/help_topics/__init__.py \
125
bzrlib/sign_my_commits.py \
126
bzrlib/bugtracker.py \
128
tools/doc_generate/__init__.py \
129
tools/doc_generate/autodoc_man.py \
130
tools/doc_generate/autodoc_rstx.py \
131
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
133
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
134
$(PYTHON) generate_docs.py -o $@ rstx
136
doc/en/developer-guide/HACKING.txt: doc/developers/HACKING.txt
137
$(PYTHON) tools/win32/ostools.py copytodir doc/developers/HACKING.txt doc/en/developer-guide
139
doc/en/release-notes/NEWS.txt: NEWS
140
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
142
MAN_PAGES = man1/bzr.1
143
man1/bzr.1: $(MAN_DEPENDENCIES)
144
$(PYTHON) generate_docs.py -o $@ man
146
# build a png of our performance task list
147
doc/developers/performance.png: doc/developers/performance.dot
149
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
151
derived_web_docs = $(htm_files) $(dev_htm_files) doc/developers/performance.png
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)
326
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
328
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
329
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
331
derived_web_docs = $(htm_files) $(dev_htm_files)
152
332
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
153
333
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
155
335
# the main target to build all the docs
336
docs-plain: $(ALL_DOCS)
158
338
# produce a tree containing just the final docs, ready for uploading to the web
340
html-plain: docs-plain
161
341
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
163
343
# clean produced docs
165
345
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
166
$(HTMLDIR) $(derived_txt_files)
346
$(HTMLDIR) $(derived_txt_files)
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 $@"
169
358
### Windows Support ###
360
# make all the installers completely from scratch, using zc.buildout
361
# to fetch the dependencies
362
# These are files that need to be copied into the build location to boostrap
364
# Note that the path is relative to tools/win32
365
BUILDOUT_FILES = buildout.cfg \
366
buildout-templates/bin/build-installer.bat.in \
367
ostools.py bootstrap.py
370
@echo Make all the installers from scratch
371
@# Build everything in a separate directory, to avoid cluttering the WT
372
$(PYTHON) tools/win32/ostools.py makedir build-win32
373
@# cd to tools/win32 so that the relative paths are copied correctly
374
cd tools/win32 && $(PYTHON) ostools.py copytree $(BUILDOUT_FILES) ../../build-win32
375
@# There seems to be a bug in gf.release.bzr, It doesn't correctly update
376
@# existing release directories, so delete them manually before building
377
@# It means things may be rebuilt that don't need to be, but at least
378
@# it will be correct when they do.
379
cd build-win32 && $(PYTHON) ostools.py remove release */release
380
cd build-win32 && $(PYTHON) bootstrap.py
381
cd build-win32 && bin/buildout
382
cd build-win32 && bin/build-installer.bat $(BZR_TARGET) $(PLUGIN_TARGET)
386
$(PYTHON) tools/win32/ostools.py remove build-win32
171
388
# make bzr.exe for win32 with py2exe
173
390
@echo *** Make bzr.exe
391
$(PYTHON) tools/win32/ostools.py remove bzrlib/*.pyd
174
392
$(PYTHON) setup.py build_ext -i -f $(PYTHON_BUILDFLAGS)
175
393
$(PYTHON) setup.py py2exe > py2exe.log
176
394
$(PYTHON) tools/win32/ostools.py copytodir tools/win32/start_bzr.bat win32_bzr.exe