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
# FIXME: better move the content of doc/en/conf.py here and cleanup the result
14
# If extensions (or modules to document with autodoc) are in another directory,
15
# add these directories to sys.path here. If the directory is relative to the
16
# documentation root, use os.path.abspath to make it absolute, like shown here.
17
#sys.path.append(os.path.abspath('.'))
20
# -- General configuration -----------------------------------------------------
22
# Add any Sphinx extension module names here, as strings. They can be extensions
23
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
24
extensions = ['sphinx.ext.ifconfig',
25
'bzrlib.doc_generate.builders.texinfo']
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.
39
# General information about the project.
41
copyright = u'2009-2011 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
version = '.'.join(str(p) for p in bzrlib.version_info[:2])
50
# The full version, including alpha/beta/rc tags.
51
release = bzrlib.version_string
53
# The language for content autogenerated by Sphinx. Refer to documentation
54
# for a list of supported languages.
57
# There are two options for replacing |today|: either, you set today to some
58
# non-false value, then it is used:
60
# Else, today_fmt is used as the format for a strftime call.
61
#today_fmt = '%B %d, %Y'
63
# List of documents that shouldn't be included in the build.
66
# List of directories, relative to source directory, that shouldn't be searched
68
exclude_trees = ['_build']
70
# The reST default role (used for this markup: `text`) to use for all documents.
73
# If true, '()' will be appended to :func: etc. cross-reference text.
74
#add_function_parentheses = True
76
# If true, the current module name will be prepended to all description
77
# unit titles (such as .. function::).
78
#add_module_names = True
80
# If true, sectionauthor and moduleauthor directives will be shown in the
81
# output. They are ignored by default.
84
# The name of the Pygments (syntax highlighting) style to use.
85
pygments_style = 'sphinx'
87
# A list of ignored prefixes for module index sorting.
88
#modindex_common_prefix = []
91
# -- Options for HTML output ---------------------------------------------------
93
# The theme to use for HTML and HTML Help pages. Major themes that come with
94
# Sphinx are currently 'default' and 'sphinxdoc'.
95
html_theme = 'default'
97
# Theme options are theme-specific and customize the look and feel of a theme
98
# further. For a list of options available for each theme, see the
100
html_theme_options = {
101
# Unfortunately, the right sidebar breaks under IE6 and maybe IE7.
102
# So we stick with the default left placement to cater for users stuck
104
#'rightsidebar': True,
106
# Non-document areas: header (relbar), footer, sidebar, etc.
107
# Some useful colours here:
108
# * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
110
# * gray: dimgray, slategray, lightslategray
111
'sidebarbgcolor': "cornflowerblue",
112
'sidebarlinkcolor': "midnightblue",
113
'relbarbgcolor': "darkblue",
114
'footerbgcolor': "lightslategray",
116
# Text, heading and code colouring
117
'codebgcolor': "lightyellow",
118
'codetextcolor': "firebrick",
119
'linkcolor': "mediumblue",
122
# Add any paths that contain custom themes here, relative to this directory.
123
#html_theme_path = []
125
# The name for this set of Sphinx documents. If None, it defaults to
126
# "<project> v<release> documentation".
129
# A shorter title for the navigation bar. Default is the same as html_title.
130
#html_short_title = None
132
# The name of an image file (relative to this directory) to place at the top
136
# The name of an image file (within the static path) to use as favicon of the
137
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
139
html_favicon = "bzr.ico"
141
# Add any paths that contain custom static files (such as style sheets) here,
142
# relative to this directory. They are copied after the builtin static files,
143
# so a file named "default.css" will overwrite the builtin "default.css".
144
html_static_path = ['_static']
146
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
147
# using the given strftime format.
148
#html_last_updated_fmt = '%b %d, %Y'
150
# If true, SmartyPants will be used to convert quotes and dashes to
151
# typographically correct entities.
152
#html_use_smartypants = True
154
# Custom sidebar templates, maps document names to template names.
157
# Additional templates that should be rendered to pages, maps page names to
159
#html_additional_pages = {}
161
# If false, no module index is generated.
162
html_use_modindex = False
164
# If false, no index is generated.
165
html_use_index = False
167
# If true, the index is split into individual pages for each letter.
168
#html_split_index = False
170
# If true, links to the reST sources are added to the pages.
171
html_show_sourcelink = True
173
# If true, an OpenSearch description file will be output, and all pages will
174
# contain a <link> tag referring to it. The value of this option must be the
175
# base URL from which the finished HTML is served.
176
#html_use_opensearch = ''
178
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
179
#html_file_suffix = ''
181
# Output file base name for HTML help builder.
182
htmlhelp_basename = 'bzr-docs'
185
# -- Options for LaTeX output --------------------------------------------------
187
# The paper size ('letter' or 'a4').
188
#latex_paper_size = 'letter'
190
# The font size ('10pt', '11pt' or '12pt').
191
#latex_font_size = '10pt'
193
# Grouping the document tree into LaTeX files. List of tuples
194
# (source start file, target name, title, author, documentclass [howto/manual]).
197
# The name of an image file (relative to this directory) to place at the top of
199
latex_logo = '../Bazaar-Logo-For-Manuals.png'
201
# For "manual" documents, if this is true, then toplevel headings are parts,
203
#latex_use_parts = False
205
# Additional stuff for the LaTeX preamble.
208
# Documents to append as an appendix to all manuals.
209
#latex_appendices = []
211
# If false, no module index is generated.
212
#latex_use_modindex = True
215
# -- Bazaar-specific configuration ---------------------------------------------
217
# Authors of the documents
218
bzr_team = u'Bazaar Developers'
added
removed
bzrlib/doc_generate/conf.py
