1
# -*- coding: utf-8 -*-
3
# Bazaar documentation build configuration file, created by
4
# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
6
# All configuration values have a default; values that are commented out
7
# serve to show the default.
11
# If extensions (or modules to document with autodoc) are in another directory,
12
# add these directories to sys.path here. If the directory is relative to the
13
# documentation root, use os.path.abspath to make it absolute, like shown here.
14
#sys.path.append(os.path.abspath('.'))
17
# -- General configuration -----------------------------------------------------
19
# Add any Sphinx extension module names here, as strings. They can be extensions
20
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
21
extensions = ['sphinx.ext.ifconfig']
23
# Add any paths that contain templates here, relative to this directory.
24
templates_path = ['_templates']
26
# The suffix of source filenames.
27
source_suffix = '.txt'
29
# The encoding of source files.
30
#source_encoding = 'utf-8'
32
# The master toctree document.
35
# General information about the project.
37
copyright = u'2009, Canonical Ltd'
39
# The version info for the project you're documenting, acts as replacement for
40
# |version| and |release|, also used in various other places throughout the
43
# The short X.Y version.
45
version = '.'.join(str(p) for p in bzrlib.version_info[:2])
46
# The full version, including alpha/beta/rc tags.
47
release = bzrlib.version_string
49
# The language for content autogenerated by Sphinx. Refer to documentation
50
# for a list of supported languages.
53
# There are two options for replacing |today|: either, you set today to some
54
# non-false value, then it is used:
56
# Else, today_fmt is used as the format for a strftime call.
57
#today_fmt = '%B %d, %Y'
59
# List of documents that shouldn't be included in the build.
62
# List of directories, relative to source directory, that shouldn't be searched
64
exclude_trees = ['_build']
66
# The reST default role (used for this markup: `text`) to use for all documents.
69
# If true, '()' will be appended to :func: etc. cross-reference text.
70
#add_function_parentheses = True
72
# If true, the current module name will be prepended to all description
73
# unit titles (such as .. function::).
74
#add_module_names = True
76
# If true, sectionauthor and moduleauthor directives will be shown in the
77
# output. They are ignored by default.
80
# The name of the Pygments (syntax highlighting) style to use.
81
pygments_style = 'sphinx'
83
# A list of ignored prefixes for module index sorting.
84
#modindex_common_prefix = []
87
# -- Options for HTML output ---------------------------------------------------
89
# The theme to use for HTML and HTML Help pages. Major themes that come with
90
# Sphinx are currently 'default' and 'sphinxdoc'.
91
html_theme = 'default'
93
# Theme options are theme-specific and customize the look and feel of a theme
94
# further. For a list of options available for each theme, see the
96
html_theme_options = {
97
# Unfortunately, the right sidebar breaks under IE6 and maybe IE7.
98
# So we stick with the default left placement to cater for users stuck
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",
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".
125
# A shorter title for the navigation bar. Default is the same as html_title.
126
#html_short_title = None
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.
153
# Additional templates that should be rendered to pages, maps page names to
155
#html_additional_pages = {}
157
# If false, no module index is generated.
158
html_use_modindex = False
160
# If false, no index is generated.
161
html_use_index = False
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 = ''
177
# Output file base name for HTML help builder.
178
htmlhelp_basename = 'bzr-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'
189
# Grouping the document tree into LaTeX files. List of tuples
190
# (source start file, target name, title, author, documentclass [howto/manual]).
193
# The name of an image file (relative to this directory) to place at the top of
195
latex_logo = '../Bazaar-Logo-For-Manuals.png'
197
# For "manual" documents, if this is true, then toplevel headings are parts,
199
#latex_use_parts = False
201
# Additional stuff for the LaTeX preamble.
204
# Documents to append as an appendix to all manuals.
205
#latex_appendices = []
207
# If false, no module index is generated.
208
#latex_use_modindex = True
211
# -- Bazaar-specific configuration ---------------------------------------------
213
# Authors of the documents
214
bzr_team = u'Bazaar Developers'
added
removed
bzrlib/doc_generate/sphinx_conf.py
