216
213
$(PYTHON) tools/package_docs.py doc/developers $(DOC_WEBSITE_BUILD)
219
### Plain Documentation ###
221
# While Sphinx is the preferred tool for building documentation, we still
222
# support our "plain" html documentation so that Sphinx is not a hard
223
# dependency for packagers on older platforms.
225
rst2html = $(PYTHON) tools/rst2html.py --link-stylesheet --footnote-references=superscript --halt=warning
227
# translate txt docs to html
228
derived_txt_files = \
229
doc/en/release-notes/NEWS.txt
231
doc/en/tutorials/tutorial.txt \
232
doc/en/tutorials/using_breezy_with_launchpad.txt \
233
doc/en/tutorials/centralized_workflow.txt \
234
$(call sw,doc/*/mini-tutorial/index.txt) \
235
$(call sw,doc/*/user-guide/index-plain.txt) \
236
doc/en/admin-guide/index-plain.txt \
237
$(call sw,doc/es/guia-usario/*.txt) \
238
$(derived_txt_files) \
239
doc/en/upgrade-guide/index.txt \
241
$(call sw,doc/index.*.txt)
243
doc/en/user-guide/index.txt \
244
doc/en/admin-guide/index.txt
245
txt_files = $(filter-out $(txt_nohtml), $(txt_all))
246
htm_files = $(patsubst %.txt, %.html, $(txt_files))
250
$(call sw,doc/*/brz-en-quick-reference.svg) \
251
$(call sw,doc/*/brz-en-quick-reference.png) \
252
$(call sw,doc/*/brz-en-quick-reference.pdf) \
253
$(call sw,doc/*/bzr-es-quick-reference.svg) \
254
$(call sw,doc/*/bzr-es-quick-reference.png) \
255
$(call sw,doc/*/bzr-es-quick-reference.pdf) \
256
$(call sw,doc/*/bzr-ru-quick-reference.svg) \
257
$(call sw,doc/*/bzr-ru-quick-reference.png) \
258
$(call sw,doc/*/bzr-ru-quick-reference.pdf) \
259
$(call sw,doc/*/user-guide/images/*.png)
261
# doc/developers/*.txt files that should *not* be individually
264
doc/developers/add.txt \
265
doc/developers/annotate.txt \
266
doc/developers/bundle-creation.txt \
267
doc/developers/commit.txt \
268
doc/developers/diff.txt \
269
doc/developers/directory-fingerprints.txt \
270
doc/developers/gc.txt \
271
doc/developers/implementation-notes.txt \
272
doc/developers/incremental-push-pull.txt \
273
doc/developers/index.txt \
274
doc/developers/initial-push-pull.txt \
275
doc/developers/merge-scaling.txt \
276
doc/developers/miscellaneous-notes.txt \
277
doc/developers/missing.txt \
278
doc/developers/performance-roadmap-rationale.txt \
279
doc/developers/performance-use-case-analysis.txt \
280
doc/developers/planned-change-integration.txt \
281
doc/developers/planned-performance-changes.txt \
282
doc/developers/plans.txt \
283
doc/developers/process.txt \
284
doc/developers/revert.txt \
285
doc/developers/specifications.txt \
286
doc/developers/status.txt \
287
doc/developers/uncommit.txt
289
dev_txt_all = $(call sw,$(addsuffix /*.txt, doc/developers))
290
dev_txt_files = $(filter-out $(dev_txt_nohtml), $(dev_txt_all))
291
dev_htm_files = $(patsubst %.txt, %.html, $(dev_txt_files))
293
doc/en/user-guide/index-plain.html: $(call sw,$(addsuffix /*.txt, doc/en/user-guide))
294
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
296
#doc/es/user-guide/index.html: $(call sw,$(addsuffix /*.txt, doc/es/user-guide))
297
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
299
#doc/ru/user-guide/index.html: $(call sw,$(addsuffix /*.txt, doc/ru/user-guide))
300
# $(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
302
doc/en/admin-guide/index-plain.html: $(call sw,$(addsuffix /*.txt, doc/en/admin-guide))
303
$(rst2html) --stylesheet=../../default.css $(dir $@)index-plain.txt $@
305
doc/developers/%.html: doc/developers/%.txt
306
$(rst2html) --stylesheet=../default.css $< $@
308
doc/index.html: doc/index.txt
309
$(rst2html) --stylesheet=default.css $< $@
311
doc/index.%.html: doc/index.%.txt
312
$(rst2html) --stylesheet=default.css $< $@
315
$(rst2html) --stylesheet=../../default.css $< "$@"
317
doc/en/release-notes/NEWS.txt: $(NEWS_FILES) tools/generate_release_notes.py
318
$(PYTHON) tools/generate_release_notes.py "$@" $(NEWS_FILES)
320
upgrade_guide_dependencies = $(call sw,$(addsuffix /*.txt, doc/en/upgrade-guide))
322
doc/en/upgrade-guide/index.html: $(upgrade_guide_dependencies)
323
$(rst2html) --stylesheet=../../default.css $(dir $@)index.txt $@
325
derived_web_docs = $(htm_files) $(dev_htm_files)
326
WEB_DOCS = $(derived_web_docs) $(non_txt_files)
327
ALL_DOCS = $(derived_web_docs) $(MAN_PAGES)
329
# the main target to build all the docs
330
docs-plain: $(ALL_DOCS)
332
# produce a tree containing just the final docs, ready for uploading to the web
334
html-plain: docs-plain
335
$(PYTHON) tools/win32/ostools.py copytree $(WEB_DOCS) $(HTMLDIR)
337
# clean produced docs
339
$(PYTHON) tools/win32/ostools.py remove $(ALL_DOCS) \
340
$(HTMLDIR) $(derived_txt_files)
343
216
### Miscellaneous Documentation Targets ###
345
218
# build a png of our performance task list