75
75
# these are treated as phony so they'll always be rebuilt - it's pretty quick
78
79
### Documentation ###
80
# set PRETTY to get docs that look like the Bazaar web site
82
rst2html := $(PYTHON) tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid
81
# Default to plain documentation for maximum backwards compatibility.
82
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
86
clean-docs: clean-plain
91
### Man-page Documentation ###
93
MAN_DEPENDENCIES = bzrlib/builtins.py \
94
$(wildcard bzrlib/*.py) \
95
$(wildcard bzrlib/*/*.py) \
96
tools/generate_docs.py \
97
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
99
MAN_PAGES = man1/bzr.1
100
man1/bzr.1: $(MAN_DEPENDENCIES)
101
$(PYTHON) tools/generate_docs.py -o $@ man
104
### Sphinx-style Documentation ###
106
# Build the documentation. To keep the dependencies down to a minimum
107
# for distro packagers, we only build the html documentation by default.
108
# Sphinx 0.6 or later is preferred for the best rendering, though
109
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
110
# for installation instructions.
111
docs-sphinx: html-sphinx
113
# Clean out generated documentation
115
cd doc/en && make clean
116
cd doc/es && make clean
117
cd doc/ru && make clean
118
cd doc/developers && make clean
120
SPHINX_DEPENDENCIES = \
121
doc/en/release-notes/index.txt \
122
doc/en/user-reference/index.txt \
127
doc/developers/Makefile \
128
doc/developers/make.bat
130
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
131
$(PYTHON) tools/generate_docs.py -o $@ rstx
133
doc/en/release-notes/index.txt: NEWS tools/generate_release_notes.py
134
$(PYTHON) tools/generate_release_notes.py NEWS $@
136
doc/%/Makefile: doc/en/Makefile
137
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
139
doc/%/make.bat: doc/en/make.bat
140
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
142
# Build the html docs using Sphinx.
143
html-sphinx: $(SPHINX_DEPENDENCIES)
144
cd doc/en && make html
145
cd doc/es && make html
146
cd doc/ru && make html
147
cd doc/developers && make html
149
# Build the PDF docs using Sphinx. This requires numerous LaTeX
150
# packages. See http://sphinx.pocoo.org/builders.html for details.
151
# Note: We don't currently build PDFs for the Russian docs because
152
# they require additional packages to be installed (to handle
153
# Russian hyphenation rules, etc.)
154
pdf-sphinx: $(SPHINX_DEPENDENCIES)
155
cd doc/en && make latex
156
cd doc/es && make latex
157
cd doc/developers && make latex
158
cd doc/en/_build/latex && make all-pdf
159
cd doc/es/_build/latex && make all-pdf
160
cd doc/developers/_build/latex && make all-pdf
162
# Build the CHM (Windows Help) docs using Sphinx.
163
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
164
# to generate the final chm files.
165
chm-sphinx: $(SPHINX_DEPENDENCIES)
166
cd doc/en && make htmlhelp
167
cd doc/es && make htmlhelp
168
cd doc/ru && make htmlhelp
169
cd doc/developers && make htmlhelp
172
### Documentation Website ###
174
# Where to build the website
175
DOC_WEBSITE_BUILD := build_doc_website
177
# Build and package docs into a website, complete with downloads.
178
doc-website: html-sphinx pdf-sphinx
179
$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
180
$(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
181
$(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
182
$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
185
### Plain Documentation ###
187
# While Sphinx is the preferred tool for building documentation, we still
188
# support our "plain" html documentation so that Sphinx is not a hard
189
# dependency for packagers on older platforms.
84
191
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
87
193
# translate txt docs to html
88
194
derived_txt_files := \
89
195
doc/en/user-reference/bzr_man.txt \
90
196
doc/en/release-notes/NEWS.txt
92
198
doc/en/tutorials/tutorial.txt \
93
199
doc/en/tutorials/using_bazaar_with_launchpad.txt \
94
200
doc/en/tutorials/centralized_workflow.txt \
201
$(wildcard doc/es/tutorials/*.txt) \
95
202
$(wildcard doc/ru/tutorials/*.txt) \
96
203
$(wildcard doc/*/mini-tutorial/index.txt) \
97
$(wildcard doc/*/user-guide/index.txt) \
204
$(wildcard doc/*/user-guide/index-plain.txt) \
205
$(wildcard doc/es/guia-usario/*.txt) \
98
206
$(derived_txt_files) \
99
doc/en/developer-guide/HACKING.txt \
100
207
doc/en/upgrade-guide/index.txt \
101
$(wildcard doc/es/guia-usario/*.txt) \
102
doc/es/mini-tutorial/index.txt \
104
209
$(wildcard doc/index.*.txt)
211
doc/en/user-guide/index.txt \
212
doc/es/user-guide/index.txt \
213
doc/ru/user-guide/index.txt
214
txt_files := $(filter-out $(txt_nohtml), $(txt_all))
215
htm_files := $(patsubst %.txt, %.html, $(txt_files))
105
217
non_txt_files := \
106
218
doc/default.css \
107
$(wildcard doc/*/quick-reference/bzr-quick-reference.svg) \
108
$(wildcard doc/*/quick-reference/bzr-quick-reference.png) \
109
$(wildcard doc/*/quick-reference/bzr-quick-reference.pdf) \
219
$(wildcard doc/*/bzr-en-quick-reference.svg) \
220
$(wildcard doc/*/bzr-en-quick-reference.png) \
221
$(wildcard doc/*/bzr-en-quick-reference.pdf) \
222
$(wildcard doc/*/bzr-es-quick-reference.svg) \
223
$(wildcard doc/*/bzr-es-quick-reference.png) \
224
$(wildcard doc/*/bzr-es-quick-reference.pdf) \
225
$(wildcard doc/*/bzr-ru-quick-reference.svg) \
226
$(wildcard doc/*/bzr-ru-quick-reference.png) \
227
$(wildcard doc/*/bzr-ru-quick-reference.pdf) \
110
228
$(wildcard doc/*/user-guide/images/*.png)
111
htm_files := $(patsubst %.txt, %.html, $(txt_files))
113
230
# doc/developers/*.txt files that should *not* be individually
114
231
# converted to HTML
136
259
dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
137
260
dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
139
doc/%/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/%/user-guide))
140
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
142
# Set the paper size for PDF files.
143
# Options: 'a4' (ISO A4 size), 'letter' (US Letter size)
145
# TODO: Add generation for Russian PDF
146
PDF_DOCS := doc/en/user-guide/user-guide.$(PAPERSIZE).pdf
148
# Copy and modify the RST sources, and convert SVG images to PDF
149
# files for use a images in the LaTeX-generated PDF.
150
# Then generate the PDF output from the modified RST sources.
151
doc/en/user-guide/user-guide.$(PAPERSIZE).pdf: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
152
mkdir -p doc/en/user-guide/latex_prepared
153
$(PYTHON) tools/prepare_for_latex.py \
154
--out-dir=doc/en/user-guide/latex_prepared \
155
--in-dir=doc/en/user-guide
156
cd doc/en/user-guide/latex_prepared && \
157
$(PYTHON) ../../../../tools/rst2pdf.py \
158
--documentoptions=10pt,$(PAPERSIZE)paper \
159
--input-encoding=UTF-8:strict --output-encoding=UTF-8:strict \
160
--strict --title="Bazaar User Guide" \
161
index.txt ../user-guide.$(PAPERSIZE).pdf
262
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
263
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
265
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide))
266
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
268
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide))
269
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
163
271
doc/developers/%.html: doc/developers/%.txt
164
272
$(rst2html) --stylesheet=../default.css $< $@
173
281
$(rst2html) --stylesheet=../../default.css $< $@
175
MAN_DEPENDENCIES = bzrlib/builtins.py \
176
$(wildcard bzrlib/*.py) \
177
$(wildcard bzrlib/*/*.py) \
178
tools/generate_docs.py \
179
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
181
283
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
182
284
$(PYTHON) tools/generate_docs.py -o $@ rstx
184
286
doc/en/release-notes/NEWS.txt: NEWS
185
287
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
187
MAN_PAGES = man1/bzr.1
188
man1/bzr.1: $(MAN_DEPENDENCIES)
189
$(PYTHON) tools/generate_docs.py -o $@ man
191
289
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
193
291
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
194
292
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
196
# build a png of our performance task list
198
# this is no longer built by default; you can build it if you want to look at it
199
doc/developers/performance.png: doc/developers/performance.dot
201
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
203
294
derived_web_docs = $(htm_files) $(dev_htm_files)
204
295
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
205
296
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
207
298
# the main target to build all the docs
299
docs-plain: $(ALL_DOCS)
210
301
# produce a tree containing just the final docs, ready for uploading to the web
211
302
HTMLDIR := html_docs
303
html-plain: docs-plain
213
304
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
215
# Produce PDF documents. Requires pdfLaTeX, rubber, and Inkscape.
216
pdf-docs: $(PDF_DOCS)
218
306
# clean produced docs
220
308
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
221
309
$(HTMLDIR) $(derived_txt_files)
222
rm -f doc/*/user-guide/*.pdf
223
rm -rf doc/*/user-guide/latex_prepared
312
### Miscellaneous Documentation Targets ###
314
# build a png of our performance task list
315
# this is no longer built by default; you can build it if you want to look at it
316
doc/developers/performance.png: doc/developers/performance.dot
318
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
226
321
### Windows Support ###
added
removed
Makefile
