← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/doc_generate/conf.py

  • Committer: Vincent Ladeuil
  • Date: 2013-08-09 15:09:23 UTC
  • mto: This revision was merged to the branch mainline in revision 6587.
  • Revision ID: v.ladeuil+lp@free.fr-20130809150923-y71dusyorep0hbkt
Fix various typos in docstrings. Rename 'buffer' to 'buf' since it's now a python builtin function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/doc_generate/conf.py
 
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
# All configuration values have a default; values that are commented out
 
7
# serve to show the default.
 
8
 
 
9
from __future__ import absolute_import
 
10
 
 
11
# FIXME: better move the content of doc/en/conf.py here and cleanup the result
 
12
# -- vila 20100428
 
13
 
 
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('.'))
 
18
 
 
19
 
 
20
# -- General configuration -----------------------------------------------------
 
21
 
 
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
 
 
26
# Add any paths that contain templates here, relative to this directory.
 
27
templates_path = ['_templates']
 
28
 
 
29
# The suffix of source filenames.
 
30
source_suffix = '.txt'
 
31
 
 
32
# The encoding of source files.
 
33
#source_encoding = 'utf-8'
 
34
 
 
35
# The master toctree document.
 
36
master_doc = 'index'
 
37
 
 
38
# General information about the project.
 
39
project = u'Bazaar'
 
40
copyright = u'2009-2011 Canonical Ltd'
 
41
 
 
42
# The version info for the project you're documenting, acts as replacement for
 
43
# |version| and |release|, also used in various other places throughout the
 
44
# built documents.
 
45
#
 
46
# The short X.Y version.
 
47
import bzrlib
 
48
version = '.'.join(str(p) for p in bzrlib.version_info[:2])
 
49
# The full version, including alpha/beta/rc tags.
 
50
release = bzrlib.version_string
 
51
 
 
52
# The language for content autogenerated by Sphinx. Refer to documentation
 
53
# for a list of supported languages.
 
54
#language = None
 
55
 
 
56
# There are two options for replacing |today|: either, you set today to some
 
57
# non-false value, then it is used:
 
58
#today = ''
 
59
# Else, today_fmt is used as the format for a strftime call.
 
60
#today_fmt = '%B %d, %Y'
 
61
 
 
62
# List of documents that shouldn't be included in the build.
 
63
#unused_docs = []
 
64
 
 
65
# List of directories, relative to source directory, that shouldn't be searched
 
66
# for source files.
 
67
exclude_trees = ['_build']
 
68
 
 
69
# The reST default role (used for this markup: `text`) to use for all documents.
 
70
#default_role = None
 
71
 
 
72
# If true, '()' will be appended to :func: etc. cross-reference text.
 
73
#add_function_parentheses = True
 
74
 
 
75
# If true, the current module name will be prepended to all description
 
76
# unit titles (such as .. function::).
 
77
#add_module_names = True
 
78
 
 
79
# If true, sectionauthor and moduleauthor directives will be shown in the
 
80
# output. They are ignored by default.
 
81
#show_authors = False
 
82
 
 
83
# The name of the Pygments (syntax highlighting) style to use.
 
84
pygments_style = 'sphinx'
 
85
 
 
86
# A list of ignored prefixes for module index sorting.
 
87
#modindex_common_prefix = []
 
88
 
 
89
 
 
90
# -- Options for HTML output ---------------------------------------------------
 
91
 
 
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'
 
95
 
 
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
 
98
# documentation.
 
99
html_theme_options = {
 
100
    # Unfortunately, the right sidebar breaks under IE6 and maybe IE7.
 
101
    # So we stick with the default left placement to cater for users stuck
 
102
    # on those browsers.
 
103
    #'rightsidebar': True,
 
104
 
 
105
    # Non-document areas: header (relbar), footer, sidebar, etc.
 
106
    # Some useful colours here:
 
107
    # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
 
108
    #   midnightblue
 
109
    # * gray: dimgray, slategray, lightslategray
 
110
    'sidebarbgcolor':   "cornflowerblue",
 
111
    'sidebarlinkcolor': "midnightblue",
 
112
    'relbarbgcolor':    "darkblue",
 
113
    'footerbgcolor':    "lightslategray",
 
114
 
 
115
    # Text, heading and code colouring
 
116
    'codebgcolor':      "lightyellow",
 
117
    'codetextcolor':    "firebrick",
 
118
    'linkcolor':        "mediumblue",
 
119
    }
 
120
 
 
121
# Add any paths that contain custom themes here, relative to this directory.
 
122
#html_theme_path = []
 
123
 
 
124
# The name for this set of Sphinx documents.  If None, it defaults to
 
125
# "<project> v<release> documentation".
 
126
#html_title = None
 
127
 
 
128
# A shorter title for the navigation bar.  Default is the same as html_title.
 
129
#html_short_title = None
 
130
 
 
131
# The name of an image file (relative to this directory) to place at the top
 
132
# of the sidebar.
 
133
#html_logo = None
 
134
 
 
135
# The name of an image file (within the static path) to use as favicon of the
 
136
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 
137
# pixels large.
 
138
html_favicon = "bzr.ico"
 
139
 
 
140
# Add any paths that contain custom static files (such as style sheets) here,
 
141
# relative to this directory. They are copied after the builtin static files,
 
142
# so a file named "default.css" will overwrite the builtin "default.css".
 
143
html_static_path = ['_static']
 
144
 
 
145
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 
146
# using the given strftime format.
 
147
#html_last_updated_fmt = '%b %d, %Y'
 
148
 
 
149
# If true, SmartyPants will be used to convert quotes and dashes to
 
150
# typographically correct entities.
 
151
#html_use_smartypants = True
 
152
 
 
153
# Custom sidebar templates, maps document names to template names.
 
154
#html_sidebars = {}
 
155
 
 
156
# Additional templates that should be rendered to pages, maps page names to
 
157
# template names.
 
158
#html_additional_pages = {}
 
159
 
 
160
# If false, no module index is generated.
 
161
html_use_modindex = False
 
162
 
 
163
# If false, no index is generated.
 
164
html_use_index = False
 
165
 
 
166
# If true, the index is split into individual pages for each letter.
 
167
#html_split_index = False
 
168
 
 
169
# If true, links to the reST sources are added to the pages.
 
170
html_show_sourcelink = True
 
171
 
 
172
# If true, an OpenSearch description file will be output, and all pages will
 
173
# contain a <link> tag referring to it.  The value of this option must be the
 
174
# base URL from which the finished HTML is served.
 
175
#html_use_opensearch = ''
 
176
 
 
177
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 
178
#html_file_suffix = ''
 
179
 
 
180
# Output file base name for HTML help builder.
 
181
htmlhelp_basename = 'bzr-docs'
 
182
 
 
183
 
 
184
# -- Options for LaTeX output --------------------------------------------------
 
185
 
 
186
# The paper size ('letter' or 'a4').
 
187
#latex_paper_size = 'letter'
 
188
 
 
189
# The font size ('10pt', '11pt' or '12pt').
 
190
#latex_font_size = '10pt'
 
191
 
 
192
# Grouping the document tree into LaTeX files. List of tuples
 
193
# (source start file, target name, title, author, documentclass [howto/manual]).
 
194
latex_documents = []
 
195
 
 
196
# The name of an image file (relative to this directory) to place at the top of
 
197
# the title page.
 
198
latex_logo = '../Bazaar-Logo-For-Manuals.png'
 
199
 
 
200
# For "manual" documents, if this is true, then toplevel headings are parts,
 
201
# not chapters.
 
202
#latex_use_parts = False
 
203
 
 
204
# Additional stuff for the LaTeX preamble.
 
205
#latex_preamble = ''
 
206
 
 
207
# Documents to append as an appendix to all manuals.
 
208
#latex_appendices = []
 
209
 
 
210
# If false, no module index is generated.
 
211
#latex_use_modindex = True
 
212
 
 
213
 
 
214
# -- Bazaar-specific configuration ---------------------------------------------
 
215
 
 
216
# Authors of the documents
 
217
bzr_team = u'Bazaar Developers'