← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/conf.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-07 07:44:36 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090907074436-pede7phglz90jrvf
split developer docs into their own website/chm file

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/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
# This file is execfile()d with the current directory set to its containing dir.
 
7
#
 
8
# Note that not all possible configuration values are present in this
 
9
# autogenerated file.
 
10
#
 
11
# All configuration values have a default; values that are commented out
 
12
# serve to show the default.
 
13
 
 
14
import sys, os
 
15
 
 
16
# If extensions (or modules to document with autodoc) are in another directory,
 
17
# add these directories to sys.path here. If the directory is relative to the
 
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
 
19
#sys.path.append(os.path.abspath('.'))
 
20
 
 
21
# -- Bazaar-specific configuration ---------------------------------------------
 
22
 
 
23
# NOTE: Editing this section is generally all that is required ...
 
24
 
 
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)
 
28
 
 
29
 
 
30
# -- General configuration -----------------------------------------------------
 
31
 
 
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']
 
35
 
 
36
# Add any paths that contain templates here, relative to this directory.
 
37
templates_path = ['_templates']
 
38
 
 
39
# The suffix of source filenames.
 
40
source_suffix = '.txt'
 
41
 
 
42
# The encoding of source files.
 
43
#source_encoding = 'utf-8'
 
44
 
 
45
# The master toctree document.
 
46
master_doc = 'index'
 
47
 
 
48
# General information about the project.
 
49
project = u'Bazaar'
 
50
copyright = u'2009, Canonical Ltd'
 
51
 
 
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
 
54
# built documents.
 
55
#
 
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:])
 
60
 
 
61
# The language for content autogenerated by Sphinx. Refer to documentation
 
62
# for a list of supported languages.
 
63
#language = None
 
64
 
 
65
# There are two options for replacing |today|: either, you set today to some
 
66
# non-false value, then it is used:
 
67
#today = ''
 
68
# Else, today_fmt is used as the format for a strftime call.
 
69
#today_fmt = '%B %d, %Y'
 
70
 
 
71
# List of documents that shouldn't be included in the build.
 
72
#unused_docs = []
 
73
 
 
74
# List of directories, relative to source directory, that shouldn't be searched
 
75
# for source files.
 
76
exclude_trees = ['_build']
 
77
 
 
78
# The reST default role (used for this markup: `text`) to use for all documents.
 
79
#default_role = None
 
80
 
 
81
# If true, '()' will be appended to :func: etc. cross-reference text.
 
82
#add_function_parentheses = True
 
83
 
 
84
# If true, the current module name will be prepended to all description
 
85
# unit titles (such as .. function::).
 
86
#add_module_names = True
 
87
 
 
88
# If true, sectionauthor and moduleauthor directives will be shown in the
 
89
# output. They are ignored by default.
 
90
#show_authors = False
 
91
 
 
92
# The name of the Pygments (syntax highlighting) style to use.
 
93
pygments_style = 'sphinx'
 
94
 
 
95
# A list of ignored prefixes for module index sorting.
 
96
#modindex_common_prefix = []
 
97
 
 
98
 
 
99
# -- Options for HTML output ---------------------------------------------------
 
100
 
 
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'
 
104
 
 
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
 
107
# documentation.
 
108
html_theme_options = {
 
109
    'rightsidebar': True,
 
110
 
 
111
    # Non-document areas: header (relbar), footer, sidebar, etc.
 
112
    # Some useful colours here:
 
113
    # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
 
114
    #   midnightblue
 
115
    # * gray: dimgray, slategray, lightslategray
 
116
    'sidebarbgcolor':   "cornflowerblue",
 
117
    'sidebarlinkcolor': "midnightblue",
 
118
    'relbarbgcolor':    "darkblue",
 
119
    'footerbgcolor':    "lightslategray",
 
120
 
 
121
    # Text, heading and code colouring
 
122
    'codebgcolor':      "lightyellow",
 
123
    'codetextcolor':    "firebrick",
 
124
    'linkcolor':        "mediumblue",
 
125
    }
 
126
 
 
127
# Add any paths that contain custom themes here, relative to this directory.
 
128
#html_theme_path = []
 
129
 
 
130
# The name for this set of Sphinx documents.  If None, it defaults to
 
131
# "<project> v<release> documentation".
 
132
#html_title = None
 
133
 
 
134
# A shorter title for the navigation bar.  Default is the same as html_title.
 
135
html_short_title = "Table of Contents (%s)" % (release,)
 
136
 
 
137
# The name of an image file (relative to this directory) to place at the top
 
138
# of the sidebar.
 
139
#html_logo = None
 
140
 
 
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
 
143
# pixels large.
 
144
html_favicon = "bzr.ico"
 
145
 
 
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']
 
150
 
 
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'
 
154
 
 
155
# If true, SmartyPants will be used to convert quotes and dashes to
 
156
# typographically correct entities.
 
157
#html_use_smartypants = True
 
158
 
 
159
# Custom sidebar templates, maps document names to template names.
 
160
#html_sidebars = {}
 
161
 
 
162
# Additional templates that should be rendered to pages, maps page names to
 
163
# template names.
 
164
#html_additional_pages = {'index': 'index.html'}
 
165
 
 
166
# If false, no module index is generated.
 
167
html_use_modindex = False
 
168
 
 
169
# If false, no index is generated.
 
170
html_use_index = False
 
171
 
 
172
# If true, the index is split into individual pages for each letter.
 
173
#html_split_index = False
 
174
 
 
175
# If true, links to the reST sources are added to the pages.
 
176
html_show_sourcelink = True
 
177
 
 
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 = ''
 
182
 
 
183
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 
184
#html_file_suffix = ''
 
185
 
 
186
# Output file base name for HTML help builder.
 
187
htmlhelp_basename = 'bzr-en-devel-docs'
 
188
 
 
189
 
 
190
# -- Options for LaTeX output --------------------------------------------------
 
191
 
 
192
# The paper size ('letter' or 'a4').
 
193
#latex_paper_size = 'letter'
 
194
 
 
195
# The font size ('10pt', '11pt' or '12pt').
 
196
#latex_font_size = '10pt'
 
197
 
 
198
# Grouping the document tree into LaTeX files. List of tuples
 
199
# (source start file, target name, title, author, documentclass [howto/manual]).
 
200
latex_documents = [
 
201
]
 
202
 
 
203
# The name of an image file (relative to this directory) to place at the top of
 
204
# the title page.
 
205
latex_logo = '../Bazaar-Logo-For-Manuals.png'
 
206
 
 
207
# For "manual" documents, if this is true, then toplevel headings are parts,
 
208
# not chapters.
 
209
#latex_use_parts = False
 
210
 
 
211
# Additional stuff for the LaTeX preamble.
 
212
#latex_preamble = ''
 
213
 
 
214
# Documents to append as an appendix to all manuals.
 
215
#latex_appendices = []
 
216
 
 
217
# If false, no module index is generated.
 
218
#latex_use_modindex = True