89
77
# these are treated as phony so they'll always be rebuilt - it's pretty quick
93
80
### Documentation ###
95
# Default to plain documentation for maximum backwards compatibility.
96
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
100
clean-docs: clean-plain
102
html-docs: html-plain
105
### Man-page Documentation ###
107
MAN_DEPENDENCIES = bzrlib/builtins.py \
108
$(wildcard bzrlib/*.py) \
109
$(wildcard bzrlib/*/*.py) \
110
tools/generate_docs.py \
111
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
113
MAN_PAGES = man1/bzr.1
114
man1/bzr.1: $(MAN_DEPENDENCIES)
115
$(PYTHON) tools/generate_docs.py -o $@ man
118
### Sphinx-style Documentation ###
120
# Build the documentation. To keep the dependencies down to a minimum
121
# for distro packagers, we only build the html documentation by default.
122
# Sphinx 0.6 or later is preferred for the best rendering, though
123
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
124
# for installation instructions.
125
docs-sphinx: html-sphinx
127
# Clean out generated documentation
129
cd doc/en && make clean
130
cd doc/es && make clean
131
cd doc/ja && make clean
132
cd doc/ru && make clean
133
cd doc/developers && make clean
135
SPHINX_DEPENDENCIES = \
136
doc/en/release-notes/index.txt \
137
doc/en/user-reference/index.txt \
144
doc/developers/Makefile \
145
doc/developers/make.bat
147
NEWS_FILES = $(wildcard doc/en/release-notes/bzr-*.txt)
149
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
150
$(PYTHON) tools/generate_docs.py -o $@ rstx
152
doc/en/release-notes/index.txt: $(NEWS_FILES) tools/generate_release_notes.py
153
$(PYTHON) tools/generate_release_notes.py $@ $(NEWS_FILES)
155
doc/%/Makefile: doc/en/Makefile
156
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
158
doc/%/make.bat: doc/en/make.bat
159
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
161
# Build the html docs using Sphinx.
162
html-sphinx: $(SPHINX_DEPENDENCIES)
163
cd doc/en && make html
164
cd doc/es && make html
165
cd doc/ru && make html
166
cd doc/ja && make html
167
cd doc/developers && make html
169
# Build the PDF docs using Sphinx. This requires numerous LaTeX
170
# packages. See http://sphinx.pocoo.org/builders.html for details.
171
# Note: We don't currently build PDFs for the Russian docs because
172
# they require additional packages to be installed (to handle
173
# Russian hyphenation rules, etc.)
174
pdf-sphinx: $(SPHINX_DEPENDENCIES)
175
cd doc/en && make latex
176
cd doc/es && make latex
177
cd doc/ja && make latex
178
cd doc/developers && make latex
179
cd doc/en/_build/latex && make all-pdf
180
cd doc/es/_build/latex && make all-pdf
181
cd doc/developers/_build/latex && make all-pdf
183
# Build the CHM (Windows Help) docs using Sphinx.
184
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
185
# to generate the final chm files.
186
chm-sphinx: $(SPHINX_DEPENDENCIES)
187
cd doc/en && make htmlhelp
188
cd doc/es && make htmlhelp
189
cd doc/ru && make htmlhelp
190
cd doc/ja && make htmlhelp
191
cd doc/developers && make htmlhelp
194
### Documentation Website ###
196
# Where to build the website
197
DOC_WEBSITE_BUILD = build_doc_website
199
# Build and package docs into a website, complete with downloads.
200
doc-website: html-sphinx pdf-sphinx
201
$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
202
$(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
203
$(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
204
$(PYTHON) tools/package_docs.py doc/ja $(DOC_WEBSITE_BUILD)
205
$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
208
### Plain Documentation ###
210
# While Sphinx is the preferred tool for building documentation, we still
211
# support our "plain" html documentation so that Sphinx is not a hard
212
# dependency for packagers on older platforms.
214
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
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
216
89
# translate txt docs to html
217
derived_txt_files = \
90
derived_txt_files := \
91
doc/en/user-reference/bzr_man.txt \
218
92
doc/en/release-notes/NEWS.txt
220
94
doc/en/tutorials/tutorial.txt \
221
95
doc/en/tutorials/using_bazaar_with_launchpad.txt \
222
96
doc/en/tutorials/centralized_workflow.txt \
223
$(wildcard doc/es/tutorials/*.txt) \
224
$(wildcard doc/ru/tutorials/*.txt) \
225
doc/ja/tutorials/tutorial.txt \
226
doc/ja/tutorials/using_bazaar_with_launchpad.txt \
227
doc/ja/tutorials/centralized_workflow.txt \
97
$(wildcard doc/ru/tutorials/*.txt) \
228
98
$(wildcard doc/*/mini-tutorial/index.txt) \
229
$(wildcard doc/*/user-guide/index-plain.txt) \
230
doc/en/admin-guide/index-plain.txt \
231
$(wildcard doc/es/guia-usario/*.txt) \
99
$(wildcard doc/*/user-guide/index.txt) \
232
100
$(derived_txt_files) \
101
doc/en/developer-guide/HACKING.txt \
233
102
doc/en/upgrade-guide/index.txt \
103
$(wildcard doc/es/guia-usario/*.txt) \
104
doc/es/mini-tutorial/index.txt \
235
106
$(wildcard doc/index.*.txt)
237
doc/en/user-guide/index.txt \
238
doc/es/user-guide/index.txt \
239
doc/ja/user-guide/index.txt \
240
doc/ru/user-guide/index.txt \
241
doc/en/admin-guide/index.txt
242
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
243
htm_files = $(patsubst %.txt, %.html, $(txt_files))
246
108
doc/default.css \
247
$(wildcard doc/*/bzr-en-quick-reference.svg) \
248
$(wildcard doc/*/bzr-en-quick-reference.png) \
249
$(wildcard doc/*/bzr-en-quick-reference.pdf) \
250
$(wildcard doc/*/bzr-es-quick-reference.svg) \
251
$(wildcard doc/*/bzr-es-quick-reference.png) \
252
$(wildcard doc/*/bzr-es-quick-reference.pdf) \
253
$(wildcard doc/*/bzr-ru-quick-reference.svg) \
254
$(wildcard doc/*/bzr-ru-quick-reference.png) \
255
$(wildcard doc/*/bzr-ru-quick-reference.pdf) \
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
112
$(wildcard doc/*/user-guide/images/*.png)
113
htm_files := $(patsubst %.txt, %.html, $(txt_files))
258
115
# doc/developers/*.txt files that should *not* be individually
259
116
# converted to HTML
261
118
doc/developers/add.txt \
262
119
doc/developers/annotate.txt \
263
120
doc/developers/bundle-creation.txt \
265
122
doc/developers/diff.txt \
266
123
doc/developers/directory-fingerprints.txt \
267
124
doc/developers/gc.txt \
268
doc/developers/implementation-notes.txt \
269
125
doc/developers/incremental-push-pull.txt \
270
doc/developers/index.txt \
271
126
doc/developers/initial-push-pull.txt \
272
127
doc/developers/merge-scaling.txt \
273
doc/developers/miscellaneous-notes.txt \
274
128
doc/developers/missing.txt \
275
129
doc/developers/performance-roadmap-rationale.txt \
276
130
doc/developers/performance-use-case-analysis.txt \
277
131
doc/developers/planned-change-integration.txt \
278
132
doc/developers/planned-performance-changes.txt \
279
doc/developers/plans.txt \
280
doc/developers/process.txt \
281
133
doc/developers/revert.txt \
282
doc/developers/specifications.txt \
283
134
doc/developers/status.txt \
284
135
doc/developers/uncommit.txt
286
dev_txt_all = $(wildcard $(addsuffix /*.txt, doc/developers))
287
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
288
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files))
290
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
291
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
293
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide))
294
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
296
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide))
297
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
299
doc/en/admin-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/admin-guide))
300
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.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
302
165
doc/developers/%.html: doc/developers/%.txt
303
166
$(rst2html) --stylesheet=../default.css $< $@
309
172
$(rst2html) --stylesheet=default.css $< $@
312
$(rst2html) --stylesheet=../../default.css $< "$@"
314
doc/en/release-notes/NEWS.txt: $(NEWS_FILES) tools/generate_release_notes.py
315
$(PYTHON) tools/generate_release_notes.py "$@" $(NEWS_FILES)
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
317
193
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
319
195
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
320
196
$(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 $@"
322
205
derived_web_docs = $(htm_files) $(dev_htm_files)
323
206
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
324
207
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
326
209
# the main target to build all the docs
327
docs-plain: $(ALL_DOCS)
329
212
# produce a tree containing just the final docs, ready for uploading to the web
331
html-plain: docs-plain
332
215
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
217
# Produce PDF documents. Requires pdfLaTeX, rubber, and Inkscape.
218
pdf-docs: $(PDF_DOCS)
334
220
# clean produced docs
336
222
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
337
223
$(HTMLDIR) $(derived_txt_files)
340
### Miscellaneous Documentation Targets ###
342
# build a png of our performance task list
343
# this is no longer built by default; you can build it if you want to look at it
344
doc/developers/performance.png: doc/developers/performance.dot
346
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
224
rm -f doc/*/user-guide/*.pdf
225
rm -rf doc/*/user-guide/latex_prepared
349
228
### Windows Support ###