~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/doc_generate/sphinx_conf.py

Committer: Ian Clatworthy
Date: 2009-09-08 16:37:05 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-20090908163705-50olbndnrr2x2389

moce most of the sphinx configuration settings into a central place

files added:
bzrlib/doc_generate/sphinx_conf.py

files modified:
doc/en/conf.py

Show diffs side-by-side

added added

removed removed

bzrlib/doc_generate/sphinx_conf.py

# -*- coding: utf-8 -*-

# Bazaar documentation build configuration file, created by

# sphinx-quickstart on Tue Jul 21 17:04:52 2009.

# All configuration values have a default; values that are commented out

# serve to show the default.

import sys, os

# If extensions (or modules to document with autodoc) are in another directory,

# add these directories to sys.path here. If the directory is relative to the

# documentation root, use os.path.abspath to make it absolute, like shown here.

#sys.path.append(os.path.abspath('.'))

# -- General configuration -----------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be extensions

# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

extensions = ['sphinx.ext.ifconfig']

# Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']

# The suffix of source filenames.

source_suffix = '.txt'

# The encoding of source files.

#source_encoding = 'utf-8'

# The master toctree document.

master_doc = 'index'

# General information about the project.

project = u'Bazaar'

# The version info for the project you're documenting, acts as replacement for

# |version| and |release|, also used in various other places throughout the

# built documents.

# The short X.Y version.

import bzrlib

version = '.'.join(str(p) for p in bzrlib.version_info[:2])

# The full version, including alpha/beta/rc tags.

release = bzrlib.version_string

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

#language = None

# There are two options for replacing |today|: either, you set today to some

# non-false value, then it is used:

#today = ''

# Else, today_fmt is used as the format for a strftime call.

#today_fmt = '%B %d, %Y'

# List of documents that shouldn't be included in the build.

#unused_docs = []

# List of directories, relative to source directory, that shouldn't be searched

# for source files.

exclude_trees = ['_build']

# The reST default role (used for this markup: `text`) to use for all documents.

#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.

#add_function_parentheses = True

# If true, the current module name will be prepended to all description

# unit titles (such as .. function::).

#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the

# output. They are ignored by default.

#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.

pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.

#modindex_common_prefix = []

# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages. Major themes that come with

# Sphinx are currently 'default' and 'sphinxdoc'.

html_theme = 'default'

# Theme options are theme-specific and customize the look and feel of a theme

# further. For a list of options available for each theme, see the

# documentation.

html_theme_options = {

# Unfortunately, the right sidebar breaks under IE6 and maybe IE7.

# So we stick with the default left placement to cater for users stuck

# on those browsers.

100

#'rightsidebar': True,

101

102

# Non-document areas: header (relbar), footer, sidebar, etc.

103

# Some useful colours here:

104

# * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,

105

# midnightblue

106

# * gray: dimgray, slategray, lightslategray

107

'sidebarbgcolor': "cornflowerblue",

108

'sidebarlinkcolor': "midnightblue",

109

'relbarbgcolor': "darkblue",

110

'footerbgcolor': "lightslategray",

111

112

# Text, heading and code colouring

113

'codebgcolor': "lightyellow",

114

'codetextcolor': "firebrick",

115

'linkcolor': "mediumblue",

116

}

117

118

# Add any paths that contain custom themes here, relative to this directory.

119

#html_theme_path = []

120

121

# The name for this set of Sphinx documents. If None, it defaults to

122

# "<project> v<release> documentation".

123

#html_title = None

124

125

# A shorter title for the navigation bar. Default is the same as html_title.

126

#html_short_title = None

127

128

# The name of an image file (relative to this directory) to place at the top

129

# of the sidebar.

130

#html_logo = None

131

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

134

# pixels large.

135

html_favicon = "bzr.ico"

136

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']

141

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'

145

146

# If true, SmartyPants will be used to convert quotes and dashes to

147

# typographically correct entities.

148

#html_use_smartypants = True

149

150

# Custom sidebar templates, maps document names to template names.

151

#html_sidebars = {}

152

153

# Additional templates that should be rendered to pages, maps page names to

154

# template names.

155

#html_additional_pages = {}

156

157

# If false, no module index is generated.

158

html_use_modindex = False

159

160

# If false, no index is generated.

161

html_use_index = False

162

163

# If true, the index is split into individual pages for each letter.

164

#html_split_index = False

165

166

# If true, links to the reST sources are added to the pages.

167

html_show_sourcelink = True

168

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 = ''

173

174

# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").

175

#html_file_suffix = ''

176

177

# Output file base name for HTML help builder.

178

htmlhelp_basename = 'bzr-docs'

179

180

181

# -- Options for LaTeX output --------------------------------------------------

182

183

# The paper size ('letter' or 'a4').

184

#latex_paper_size = 'letter'

185

186

# The font size ('10pt', '11pt' or '12pt').

187

#latex_font_size = '10pt'

188

189

# Grouping the document tree into LaTeX files. List of tuples

190

# (source start file, target name, title, author, documentclass [howto/manual]).

191

latex_documents = []

192

193

# The name of an image file (relative to this directory) to place at the top of

194

# the title page.

195

latex_logo = '../Bazaar-Logo-For-Manuals.png'

196

197

# For "manual" documents, if this is true, then toplevel headings are parts,

198

# not chapters.

199

#latex_use_parts = False

200

201

# Additional stuff for the LaTeX preamble.

202

#latex_preamble = ''

203

204

# Documents to append as an appendix to all manuals.

205

#latex_appendices = []

206

207

# If false, no module index is generated.

208

#latex_use_modindex = True

209

210

211

# -- Bazaar-specific configuration ---------------------------------------------

212

213

# Authors of the documents

214

bzr_team = u'Bazaar Developers'

Older »