4634.39.10
by Ian Clatworthy
split developer docs into their own website/chm file |
1 |
# -*- coding: utf-8 -*-
|
2 |
#
|
|
3 |
# Bazaar documentation build configuration file, created by
|
|
4 |
# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
|
|
5 |
#
|
|
6 |
# This file is execfile()d with the current directory set to its containing dir.
|
|
7 |
||
8 |
import sys, os |
|
9 |
||
10 |
# If extensions (or modules to document with autodoc) are in another directory,
|
|
11 |
# add these directories to sys.path here. If the directory is relative to the
|
|
12 |
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
4634.39.27
by Ian Clatworthy
reuse the central configuration |
13 |
sys.path = [os.path.abspath('../..')] + sys.path |
14 |
||
15 |
# Most of the configuration for Bazaar docs is defined here ...
|
|
5193.6.28
by Vincent Ladeuil
Fix remaining sphinx_conf references. |
16 |
from bzrlib.doc_generate.conf import * |
4634.39.27
by Ian Clatworthy
reuse the central configuration |
17 |
|
18 |
||
19 |
## Configuration specific to this site ##
|
|
20 |
||
21 |
# The locale code for this documentation set
|
|
22 |
bzr_locale = 'en' |
|
4634.39.10
by Ian Clatworthy
split developer docs into their own website/chm file |
23 |
|
24 |
# A shorter title for the navigation bar. Default is the same as html_title.
|
|
4634.39.28
by Ian Clatworthy
fix typo in developers/conf.py |
25 |
html_short_title = u"Developer Document Catalog (%s)" % (release,) |
4634.39.10
by Ian Clatworthy
split developer docs into their own website/chm file |
26 |
|
27 |
# Additional templates that should be rendered to pages, maps page names to
|
|
28 |
# template names.
|
|
29 |
#html_additional_pages = {'index': 'index.html'}
|
|
30 |
||
31 |
# Output file base name for HTML help builder.
|
|
4634.39.30
by Ian Clatworthy
tweak chm file naming |
32 |
htmlhelp_basename = 'bzr-developers' |
4634.39.10
by Ian Clatworthy
split developer docs into their own website/chm file |
33 |
|
34 |
# Grouping the document tree into LaTeX files. List of tuples
|
|
35 |
# (source start file, target name, title, author, documentclass [howto/manual]).
|
|
6437.48.1
by Vincent Ladeuil
Rely on sphinx for texinfo doc generation |
36 |
bzr_documents = [ |
37 |
('HACKING', 'bzr-en-developer-guide', u'Bazaar Developer Guide', |
|
38 |
u'Bazaar Developers', 'manual'), |
|
39 |
('testing', 'bzr-en-testing-guide', u'Bazaar Testing Guide', |
|
40 |
u'Bazaar Developers', 'manual'), |
|
41 |
('overview', 'bzr-en-architecture-overview', u'Bazaar Architecture Overview', |
|
42 |
u'Bazaar Developers', 'howto'), |
|
43 |
('integration', 'bzr-en-integration-guide', u'Bazaar Integration Guide', |
|
44 |
u'Bazaar Developers', 'howto'), |
|
45 |
]
|
|
46 |
||
4634.39.10
by Ian Clatworthy
split developer docs into their own website/chm file |
47 |
latex_documents = [ |
6437.48.1
by Vincent Ladeuil
Rely on sphinx for texinfo doc generation |
48 |
(start, target+'.tex', title, author, doc_class) |
49 |
for start, target, title, author, doc_class in bzr_documents |
|
50 |
]
|
|
51 |
||
52 |
texinfo_documents = [ |
|
53 |
(start, target, title, author, doc_class) |
|
54 |
for start, target, title, author, doc_class in bzr_documents |
|
55 |
]
|
|
4634.39.43
by Ian Clatworthy
configure more documents to exclude from sphinx builds |
56 |
|
57 |
# List of documents that shouldn't be included in the build.
|
|
4634.39.45
by Ian Clatworthy
es/ru/developers docs to exclude from sphinx builds |
58 |
# Note: Maybe some of them *ought* to be linked in somewhere?
|
4634.39.43
by Ian Clatworthy
configure more documents to exclude from sphinx builds |
59 |
unused_docs = [ |
4634.39.45
by Ian Clatworthy
es/ru/developers docs to exclude from sphinx builds |
60 |
'add', |
61 |
'annotate', |
|
62 |
'bundle-creation', |
|
63 |
'bundle-format4', |
|
64 |
'check', |
|
65 |
'commit', |
|
66 |
'diff', |
|
67 |
'directory-fingerprints', |
|
68 |
'gc', |
|
69 |
'index-plain', |
|
70 |
'incremental-push-pull', |
|
71 |
'initial-push-pull', |
|
72 |
'merge-scaling', |
|
73 |
'missing', |
|
74 |
'performance-roadmap-rationale', |
|
75 |
'performance-use-case-analysis', |
|
76 |
'planned-change-integration', |
|
77 |
'planned-performance-changes', |
|
78 |
'revert', |
|
79 |
'status', |
|
80 |
'uncommit', |
|
4634.39.43
by Ian Clatworthy
configure more documents to exclude from sphinx builds |
81 |
]
|