77
77
# these are treated as phony so they'll always be rebuilt - it's pretty quick
80
81
### 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
83
# Default to plain documentation for maximum backwards compatibility.
84
# (Post 2.0, the defaults will most likely be Sphinx-style instead.)
88
clean-docs: clean-plain
93
### Man-page Documentation ###
95
MAN_DEPENDENCIES = bzrlib/builtins.py \
96
$(wildcard bzrlib/*.py) \
97
$(wildcard bzrlib/*/*.py) \
98
tools/generate_docs.py \
99
$(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
101
MAN_PAGES = man1/bzr.1
102
man1/bzr.1: $(MAN_DEPENDENCIES)
103
$(PYTHON) tools/generate_docs.py -o $@ man
106
### Sphinx-style Documentation ###
108
# Build the documentation. To keep the dependencies down to a minimum
109
# for distro packagers, we only build the html documentation by default.
110
# Sphinx 0.6 or later is preferred for the best rendering, though
111
# Sphinx 0.4 or later should work. See http://sphinx.pocoo.org/index.html
112
# for installation instructions.
113
docs-sphinx: html-sphinx
115
# Clean out generated documentation
117
cd doc/en && make clean
118
cd doc/es && make clean
119
cd doc/ru && make clean
120
cd doc/developers && make clean
122
SPHINX_DEPENDENCIES = \
123
doc/en/release-notes/index.txt \
124
doc/en/user-reference/index.txt \
129
doc/developers/Makefile \
130
doc/developers/make.bat
132
doc/en/user-reference/index.txt: $(MAN_DEPENDENCIES)
133
$(PYTHON) tools/generate_docs.py -o $@ rstx
135
doc/en/release-notes/index.txt: NEWS tools/generate_release_notes.py
136
$(PYTHON) tools/generate_release_notes.py NEWS $@
138
doc/%/Makefile: doc/en/Makefile
139
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
141
doc/%/make.bat: doc/en/make.bat
142
$(PYTHON) -c "import shutil; shutil.copyfile('$<', '$@')"
144
# Build the html docs using Sphinx.
145
html-sphinx: $(SPHINX_DEPENDENCIES)
146
cd doc/en && make html
147
cd doc/es && make html
148
cd doc/ru && make html
149
cd doc/developers && make html
151
# Build the PDF docs using Sphinx. This requires numerous LaTeX
152
# packages. See http://sphinx.pocoo.org/builders.html for details.
153
# Note: We don't currently build PDFs for the Russian docs because
154
# they require additional packages to be installed (to handle
155
# Russian hyphenation rules, etc.)
156
pdf-sphinx: $(SPHINX_DEPENDENCIES)
157
cd doc/en && make latex
158
cd doc/es && make latex
159
cd doc/developers && make latex
160
cd doc/en/_build/latex && make all-pdf
161
cd doc/es/_build/latex && make all-pdf
162
cd doc/developers/_build/latex && make all-pdf
164
# Build the CHM (Windows Help) docs using Sphinx.
165
# Note: HtmlHelp Workshop needs to be used on the generated hhp files
166
# to generate the final chm files.
167
chm-sphinx: $(SPHINX_DEPENDENCIES)
168
cd doc/en && make htmlhelp
169
cd doc/es && make htmlhelp
170
cd doc/ru && make htmlhelp
171
cd doc/developers && make htmlhelp
174
### Documentation Website ###
176
# Where to build the website
177
DOC_WEBSITE_BUILD := build_doc_website
179
# Build and package docs into a website, complete with downloads.
180
doc-website: html-sphinx pdf-sphinx
181
$(PYTHON) tools/package_docs.py doc/en $(DOC_WEBSITE_BUILD)
182
$(PYTHON) tools/package_docs.py doc/es $(DOC_WEBSITE_BUILD)
183
$(PYTHON) tools/package_docs.py doc/ru $(DOC_WEBSITE_BUILD)
184
$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
187
### Plain Documentation ###
189
# While Sphinx is the preferred tool for building documentation, we still
190
# support our "plain" html documentation so that Sphinx is not a hard
191
# dependency for packagers on older platforms.
86
193
rst2html := $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
89
195
# translate txt docs to html
90
196
derived_txt_files := \
91
197
doc/en/user-reference/bzr_man.txt \
92
198
doc/en/release-notes/NEWS.txt
94
200
doc/en/tutorials/tutorial.txt \
95
201
doc/en/tutorials/using_bazaar_with_launchpad.txt \
96
202
doc/en/tutorials/centralized_workflow.txt \
203
$(wildcard doc/es/tutorials/*.txt) \
97
204
$(wildcard doc/ru/tutorials/*.txt) \
98
205
$(wildcard doc/*/mini-tutorial/index.txt) \
99
$(wildcard doc/*/user-guide/index.txt) \
206
$(wildcard doc/*/user-guide/index-plain.txt) \
207
$(wildcard doc/es/guia-usario/*.txt) \
100
208
$(derived_txt_files) \
101
doc/en/developer-guide/HACKING.txt \
102
209
doc/en/upgrade-guide/index.txt \
103
$(wildcard doc/es/guia-usario/*.txt) \
104
doc/es/mini-tutorial/index.txt \
106
211
$(wildcard doc/index.*.txt)
213
doc/en/user-guide/index.txt \
214
doc/es/user-guide/index.txt \
215
doc/ru/user-guide/index.txt
216
txt_files := $(filter-out $(txt_nohtml), $(txt_all))
217
htm_files := $(patsubst %.txt, %.html, $(txt_files))
107
219
non_txt_files := \
108
220
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) \
221
$(wildcard doc/*/bzr-en-quick-reference.svg) \
222
$(wildcard doc/*/bzr-en-quick-reference.png) \
223
$(wildcard doc/*/bzr-en-quick-reference.pdf) \
224
$(wildcard doc/*/bzr-es-quick-reference.svg) \
225
$(wildcard doc/*/bzr-es-quick-reference.png) \
226
$(wildcard doc/*/bzr-es-quick-reference.pdf) \
227
$(wildcard doc/*/bzr-ru-quick-reference.svg) \
228
$(wildcard doc/*/bzr-ru-quick-reference.png) \
229
$(wildcard doc/*/bzr-ru-quick-reference.pdf) \
112
230
$(wildcard doc/*/user-guide/images/*.png)
113
htm_files := $(patsubst %.txt, %.html, $(txt_files))
115
232
# doc/developers/*.txt files that should *not* be individually
116
233
# converted to HTML
138
261
dev_txt_files := $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
139
262
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
264
doc/en/user-guide/index-plain.html: $(wildcard $(addsuffix /*.txt, doc/en/user-guide))
265
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
267
#doc/es/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/es/user-guide))
268
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
270
#doc/ru/user-guide/index.html: $(wildcard $(addsuffix /*.txt, doc/ru/user-guide))
271
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
165
273
doc/developers/%.html: doc/developers/%.txt
166
274
$(rst2html) --stylesheet=../default.css $< $@
175
283
$(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
285
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
184
286
$(PYTHON) tools/generate_docs.py -o $@ rstx
186
288
doc/en/release-notes/NEWS.txt: NEWS
187
289
$(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
193
291
upgrade_guide_dependencies = $(wildcard $(addsuffix /*.txt, doc/en/upgrade-guide))
195
293
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
196
294
$(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
296
derived_web_docs = $(htm_files) $(dev_htm_files)
206
297
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
207
298
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
209
300
# the main target to build all the docs
301
docs-plain: $(ALL_DOCS)
212
303
# produce a tree containing just the final docs, ready for uploading to the web
213
304
HTMLDIR := html_docs
305
html-plain: docs-plain
215
306
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
217
# Produce PDF documents. Requires pdfLaTeX, rubber, and Inkscape.
218
pdf-docs: $(PDF_DOCS)
220
308
# clean produced docs
222
310
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
223
311
$(HTMLDIR) $(derived_txt_files)
224
rm -f doc/*/user-guide/*.pdf
225
rm -rf doc/*/user-guide/latex_prepared
314
### Miscellaneous Documentation Targets ###
316
# build a png of our performance task list
317
# this is no longer built by default; you can build it if you want to look at it
318
doc/developers/performance.png: doc/developers/performance.dot
320
@dot -Tpng $< -o$@ || echo "Dot not installed; skipping generation of $@"
228
323
### Windows Support ###
added
removed
Makefile
