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 System Administrator's Guide": None,
32
u'Bazaar in five minutes': None,
33
u'Bazaar Tutorial': None,
34
u'Using Bazaar With Launchpad': None,
35
u'Centralized Workflow Tutorial': None,
36
u"What's New in Bazaar 2.1?": None,
19
#sys.path.append(os.path.abspath('.'))
21
# -- Bazaar-specific configuration ---------------------------------------------
23
# NOTE: Editing this section is generally all that is required ...
25
# We *could* get this from bzrlib but there's no certainly that the bzr on
26
# the Python path is indeed the one we're building the documentation for ...
27
bzr_version = (2, 0, 0, 'rc', 2)
30
# -- General configuration -----------------------------------------------------
32
# Add any Sphinx extension module names here, as strings. They can be extensions
33
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
34
extensions = ['sphinx.ext.ifconfig']
36
# Add any paths that contain templates here, relative to this directory.
37
templates_path = ['_templates']
39
# The suffix of source filenames.
40
source_suffix = '.txt'
42
# The encoding of source files.
43
#source_encoding = 'utf-8'
45
# The master toctree document.
48
# General information about the project.
50
copyright = u'2009, Canonical Ltd'
52
# The version info for the project you're documenting, acts as replacement for
53
# |version| and |release|, also used in various other places throughout the
56
# The short X.Y version.
57
version = '.'.join(str(p) for p in bzr_version[:3])
58
# The full version, including alpha/beta/rc tags.
59
release = version + ''.join(str(p) for p in bzr_version[3:])
61
# The language for content autogenerated by Sphinx. Refer to documentation
62
# for a list of supported languages.
65
# There are two options for replacing |today|: either, you set today to some
66
# non-false value, then it is used:
68
# Else, today_fmt is used as the format for a strftime call.
69
#today_fmt = '%B %d, %Y'
71
# List of documents that shouldn't be included in the build.
74
# List of directories, relative to source directory, that shouldn't be searched
76
exclude_trees = ['_build', 'ru', 'es', 'developers']
78
# The reST default role (used for this markup: `text`) to use for all documents.
81
# If true, '()' will be appended to :func: etc. cross-reference text.
82
#add_function_parentheses = True
84
# If true, the current module name will be prepended to all description
85
# unit titles (such as .. function::).
86
#add_module_names = True
88
# If true, sectionauthor and moduleauthor directives will be shown in the
89
# output. They are ignored by default.
92
# The name of the Pygments (syntax highlighting) style to use.
93
pygments_style = 'sphinx'
95
# A list of ignored prefixes for module index sorting.
96
#modindex_common_prefix = []
99
# -- Options for HTML output ---------------------------------------------------
101
# The theme to use for HTML and HTML Help pages. Major themes that come with
102
# Sphinx are currently 'default' and 'sphinxdoc'.
103
html_theme = 'default'
105
# Theme options are theme-specific and customize the look and feel of a theme
106
# further. For a list of options available for each theme, see the
108
html_theme_options = {
109
'rightsidebar': True,
111
# Non-document areas: header (relbar), footer, sidebar, etc.
112
# Some useful colours here:
113
# * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
115
# * gray: dimgray, slategray, lightslategray
116
'sidebarbgcolor': "cornflowerblue",
117
'sidebarlinkcolor': "midnightblue",
118
'relbarbgcolor': "darkblue",
119
'footerbgcolor': "lightslategray",
121
# Text, heading and code colouring
122
'codebgcolor': "lightyellow",
123
'codetextcolor': "firebrick",
124
'linkcolor': "mediumblue",
39
return bzr_titles.get(s) or s
127
# Add any paths that contain custom themes here, relative to this directory.
128
#html_theme_path = []
130
# The name for this set of Sphinx documents. If None, it defaults to
131
# "<project> v<release> documentation".
41
134
# A shorter title for the navigation bar. Default is the same as html_title.
42
html_short_title = bzr_title(u"Table of Contents (%s)") % (release,)
135
html_short_title = "Table of Contents (%s)" % (release,)
137
# The name of an image file (relative to this directory) to place at the top
141
# The name of an image file (within the static path) to use as favicon of the
142
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
144
html_favicon = "bzr.ico"
146
# Add any paths that contain custom static files (such as style sheets) here,
147
# relative to this directory. They are copied after the builtin static files,
148
# so a file named "default.css" will overwrite the builtin "default.css".
149
html_static_path = ['_static']
151
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
152
# using the given strftime format.
153
#html_last_updated_fmt = '%b %d, %Y'
155
# If true, SmartyPants will be used to convert quotes and dashes to
156
# typographically correct entities.
157
#html_use_smartypants = True
159
# Custom sidebar templates, maps document names to template names.
44
162
# Additional templates that should be rendered to pages, maps page names to
46
164
html_additional_pages = {'index': 'index.html'}
166
# If false, no module index is generated.
167
html_use_modindex = False
169
# If false, no index is generated.
170
html_use_index = False
172
# If true, the index is split into individual pages for each letter.
173
#html_split_index = False
175
# If true, links to the reST sources are added to the pages.
176
html_show_sourcelink = True
178
# If true, an OpenSearch description file will be output, and all pages will
179
# contain a <link> tag referring to it. The value of this option must be the
180
# base URL from which the finished HTML is served.
181
#html_use_opensearch = ''
183
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
184
#html_file_suffix = ''
48
186
# Output file base name for HTML help builder.
49
htmlhelp_basename = 'bzr-%s' % (bzr_locale,)
187
htmlhelp_basename = 'bzr-en-user-docs'
190
# -- Options for LaTeX output --------------------------------------------------
192
# The paper size ('letter' or 'a4').
193
#latex_paper_size = 'letter'
195
# The font size ('10pt', '11pt' or '12pt').
196
#latex_font_size = '10pt'
51
198
# Grouping the document tree into LaTeX files. List of tuples
52
199
# (source start file, target name, title, author, documentclass [howto/manual]).
53
200
latex_documents = [
55
('user-guide/index', 'bzr-%s-user-guide.tex' % (bzr_locale,),
56
bzr_title(u'Bazaar User Guide'), bzr_team, 'manual'),
57
('user-reference/bzr_man', 'bzr-%s-user-reference.tex' % (bzr_locale,),
58
bzr_title(u'Bazaar User Reference'), bzr_team, 'manual'),
59
('release-notes/NEWS', 'bzr-%s-release-notes.tex' % (bzr_locale,),
60
bzr_title(u'Bazaar Release Notes'), bzr_team, 'manual'),
61
('upgrade-guide/index', 'bzr-%s-upgrade-guide.tex' % (bzr_locale,),
62
bzr_title(u'Bazaar Upgrade Guide'), bzr_team, 'manual'),
63
('admin-guide/index', 'bzr-%s-admin-guide.tex' % (bzr_locale,),
64
bzr_title(u"Bazaar System Administrator's Guide"), bzr_team, 'manual'),
202
('en/user-guide/index', 'bzr-en-user-guide.tex', u'Bazaar User Guide',
203
u'Bazaar Developers', 'manual'),
204
('en/user-reference/bzr_man', 'bzr-en-user-reference.tex', u'Bazaar User Reference',
205
u'Bazaar Developers', 'manual'),
206
('en/release-notes/NEWS', 'bzr-en-release-notes.tex', u'Bazaar Release Notes',
207
u'Bazaar Developers', 'manual'),
208
('en/upgrade-guide/index', 'bzr-en-upgrade-guide.tex', u'Bazaar Upgrade Guide',
209
u'Bazaar Developers', 'manual'),
66
('mini-tutorial/index', 'bzr-%s-tutorial-mini.tex' % (bzr_locale,),
67
bzr_title(u'Bazaar in five minutes'), bzr_team, 'howto'),
68
('tutorials/tutorial', 'bzr-%s-tutorial.tex' % (bzr_locale,),
69
bzr_title(u'Bazaar Tutorial'), bzr_team, 'howto'),
70
('tutorials/using_bazaar_with_launchpad',
71
'bzr-%s-tutorial-with-launchpad.tex' % (bzr_locale,),
72
bzr_title(u'Using Bazaar With Launchpad'), bzr_team, 'howto'),
73
('tutorials/centralized_workflow',
74
'bzr-%s-tutorial-centralized.tex' % (bzr_locale,),
75
bzr_title(u'Centralized Workflow Tutorial'), bzr_team, 'howto'),
76
('whats-new/whats-new-in-2.1', 'bzr-%s-whats-new.tex' % (bzr_locale,),
77
bzr_title(u"What's New in Bazaar 2.1?"), bzr_team, 'howto'),
80
# List of documents that shouldn't be included in the build.
82
# Subtopics that get included
83
'upgrade-guide/overview',
84
'upgrade-guide/data_migration',
85
'upgrade-guide/tips_and_tricks',
86
# Plain-style documentation generation stuff
88
'user-reference/bzr_man',
89
'user-guide/index-plain',
90
'admin-guide/index-plain',
92
'user-reference/readme',
211
('en/mini-tutorial/index', 'bzr-en-tutorial-mini.tex', u'Bazaar in five minutes',
212
u'Bazaar Developers', 'howto'),
213
('en/tutorials/tutorial', 'bzr-en-tutorial.tex', u'Bazaar Tutorial',
214
u'Bazaar Developers', 'howto'),
215
('en/tutorials/using_bazaar_with_launchpad', 'bzr-en-tutorial-with-launchpad.tex',
216
u'Using Bazaar With Launchpad', u'Bazaar Developers', 'howto'),
217
('en/tutorials/centralized_workflow', 'bzr-en-tutorial-centralized.tex',
218
u'Centralized Workflow Tutorial', u'Bazaar Developers', 'howto'),
221
# The name of an image file (relative to this directory) to place at the top of
223
latex_logo = 'Bazaar-Logo-For-Manuals.png'
225
# For "manual" documents, if this is true, then toplevel headings are parts,
227
#latex_use_parts = False
229
# Additional stuff for the LaTeX preamble.
232
# Documents to append as an appendix to all manuals.
233
#latex_appendices = []
235
# If false, no module index is generated.
236
#latex_use_modindex = True
added
removed
doc/conf.py
