4
4
# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
6
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
10
16
# If extensions (or modules to document with autodoc) are in another directory,
11
17
# add these directories to sys.path here. If the directory is relative to the
12
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
13
sys.path = [os.path.abspath('../..')] + sys.path
15
# Most of the configuration for Bazaar docs is defined here ...
16
from bzrlib.doc_generate.sphinx_conf import *
19
## Configuration specific to this site ##
21
# The locale code for this documentation set
24
# Translations & supporting helper function
26
u'Table of Contents (%s)': None,
27
u'Bazaar User Guide': None,
28
u'Bazaar User Reference': None,
29
u'Bazaar Release Notes': None,
30
u'Bazaar Upgrade Guide': None,
31
u'Bazaar in five minutes': None,
32
u'Bazaar Tutorial': None,
33
u'Using Bazaar With Launchpad': None,
34
u'Centralized Workflow Tutorial': None,
19
#sys.path.append(os.path.abspath('.'))
21
# -- General configuration -----------------------------------------------------
23
# Add any Sphinx extension module names here, as strings. They can be extensions
24
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
25
extensions = ['sphinx.ext.ifconfig']
27
# Add any paths that contain templates here, relative to this directory.
28
templates_path = ['_templates']
30
# The suffix of source filenames.
31
source_suffix = '.txt'
33
# The encoding of source files.
34
#source_encoding = 'utf-8'
36
# The master toctree document.
37
master_doc = 'contents'
39
# General information about the project.
41
copyright = u'2009, Canonical Ltd'
43
# The version info for the project you're documenting, acts as replacement for
44
# |version| and |release|, also used in various other places throughout the
47
# The short X.Y version.
49
# The full version, including alpha/beta/rc tags.
52
# The language for content autogenerated by Sphinx. Refer to documentation
53
# for a list of supported languages.
56
# There are two options for replacing |today|: either, you set today to some
57
# non-false value, then it is used:
59
# Else, today_fmt is used as the format for a strftime call.
60
#today_fmt = '%B %d, %Y'
62
# List of documents that shouldn't be included in the build.
65
# List of directories, relative to source directory, that shouldn't be searched
67
exclude_trees = ['_build']
69
# The reST default role (used for this markup: `text`) to use for all documents.
72
# If true, '()' will be appended to :func: etc. cross-reference text.
73
#add_function_parentheses = True
75
# If true, the current module name will be prepended to all description
76
# unit titles (such as .. function::).
77
#add_module_names = True
79
# If true, sectionauthor and moduleauthor directives will be shown in the
80
# output. They are ignored by default.
83
# The name of the Pygments (syntax highlighting) style to use.
84
pygments_style = 'sphinx'
86
# A list of ignored prefixes for module index sorting.
87
#modindex_common_prefix = []
90
# -- Options for HTML output ---------------------------------------------------
92
# The theme to use for HTML and HTML Help pages. Major themes that come with
93
# Sphinx are currently 'default' and 'sphinxdoc'.
94
html_theme = 'default'
96
# Theme options are theme-specific and customize the look and feel of a theme
97
# further. For a list of options available for each theme, see the
99
html_theme_options = {
100
'rightsidebar': True,
102
# Non-document areas: header (relbar), footer, sidebar, etc.
103
# Some useful colours here:
104
# * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
106
# * gray: dimgray, slategray, lightslategray
107
'sidebarbgcolor': "cornflowerblue",
108
'sidebarlinkcolor': "midnightblue",
109
'relbarbgcolor': "darkblue",
110
'footerbgcolor': "lightslategray",
112
# Text, heading and code colouring
113
'codebgcolor': "lightyellow",
114
'codetextcolor': "firebrick",
115
'linkcolor': "mediumblue",
37
return bzr_titles.get(s) or s
118
# Add any paths that contain custom themes here, relative to this directory.
119
#html_theme_path = []
121
# The name for this set of Sphinx documents. If None, it defaults to
122
# "<project> v<release> documentation".
39
125
# A shorter title for the navigation bar. Default is the same as html_title.
40
html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
126
html_short_title = "Bazaar 2.0 Table of Contents"
128
# The name of an image file (relative to this directory) to place at the top
132
# The name of an image file (within the static path) to use as favicon of the
133
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
135
html_favicon = "bzr.ico"
137
# Add any paths that contain custom static files (such as style sheets) here,
138
# relative to this directory. They are copied after the builtin static files,
139
# so a file named "default.css" will overwrite the builtin "default.css".
140
html_static_path = ['_static']
142
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
143
# using the given strftime format.
144
#html_last_updated_fmt = '%b %d, %Y'
146
# If true, SmartyPants will be used to convert quotes and dashes to
147
# typographically correct entities.
148
#html_use_smartypants = True
150
# Custom sidebar templates, maps document names to template names.
42
153
# Additional templates that should be rendered to pages, maps page names to
44
html_additional_pages = {'index': 'index.html'}
155
html_additional_pages = {'contents': 'index.html'}
157
# If false, no module index is generated.
158
#html_use_modindex = True
160
# If false, no index is generated.
161
#html_use_index = True
163
# If true, the index is split into individual pages for each letter.
164
#html_split_index = False
166
# If true, links to the reST sources are added to the pages.
167
html_show_sourcelink = True
169
# If true, an OpenSearch description file will be output, and all pages will
170
# contain a <link> tag referring to it. The value of this option must be the
171
# base URL from which the finished HTML is served.
172
#html_use_opensearch = ''
174
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
175
#html_file_suffix = ''
46
177
# Output file base name for HTML help builder.
47
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
178
htmlhelp_basename = 'Bazaar-Docs'
181
# -- Options for LaTeX output --------------------------------------------------
183
# The paper size ('letter' or 'a4').
184
#latex_paper_size = 'letter'
186
# The font size ('10pt', '11pt' or '12pt').
187
#latex_font_size = '10pt'
49
189
# Grouping the document tree into LaTeX files. List of tuples
50
190
# (source start file, target name, title, author, documentclass [howto/manual]).
51
191
latex_documents = [
53
('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
54
bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
55
('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
56
bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
57
('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
58
bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
59
('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
60
bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
193
('en/user-guide/index', 'bzr-en-user-guide.tex', u'Bazaar User Guide',
194
u'Bazaar Developers', 'manual'),
195
('en/user-reference/bzr_man', 'bzr-en-user-reference.tex', u'Bazaar User Reference',
196
u'Bazaar Developers', 'manual'),
197
('en/release-notes/NEWS', 'bzr-en-release-notes.tex', u'Bazaar Release Notes',
198
u'Bazaar Developers', 'manual'),
199
('en/upgrade-guide/index', 'bzr-en-upgrade-guide.tex', u'Bazaar Upgrade Guide',
200
u'Bazaar Developers', 'manual'),
62
('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
63
bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
64
('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
65
bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
66
('tutorials/using_bazaar_with_launchpad',
67
'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
68
bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
69
('tutorials/centralized_workflow',
70
'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
71
bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
74
# List of documents that shouldn't be included in the build.
76
# Subtopics that get included
77
'upgrade-guide/overview',
78
'upgrade-guide/data_migration',
79
'upgrade-guide/tips_and_tricks',
80
# Plain-style documentation generation stuff
82
'user-reference/bzr_man',
83
'user-guide/index-plain',
84
'admin-guide/index-plain',
86
'user-reference/readme',
202
('en/mini-tutorial/index', 'bzr-en-tutorial-mini.tex', u'Bazaar in five minutes',
203
u'Bazaar Developers', 'howto'),
204
('en/tutorials/tutorial', 'bzr-en-tutorial.tex', u'Bazaar Tutorial',
205
u'Bazaar Developers', 'howto'),
206
('en/tutorials/using_bazaar_with_launchpad', 'bzr-en-tutorial-with-launchpad.tex',
207
u'Using Bazaar With Launchpad', u'Bazaar Developers', 'howto'),
208
('en/tutorials/centralized_workflow', 'bzr-en-tutorial-centralized.tex',
209
u'Centralized Workflow Tutorial', u'Bazaar Developers', 'howto'),
212
# The name of an image file (relative to this directory) to place at the top of
214
latex_logo = 'Bazaar-Logo-For-Manuals.png'
216
# For "manual" documents, if this is true, then toplevel headings are parts,
218
#latex_use_parts = False
220
# Additional stuff for the LaTeX preamble.
223
# Documents to append as an appendix to all manuals.
224
#latex_appendices = []
226
# If false, no module index is generated.
227
#latex_use_modindex = True
added
removed
doc/conf.py
