6
6
# All configuration values have a default; values that are commented out
7
7
# serve to show the default.
9
from __future__ import absolute_import
9
11
# FIXME: better move the content of doc/en/conf.py here and cleanup the result
12
14
# If extensions (or modules to document with autodoc) are in another directory,
13
15
# add these directories to sys.path here. If the directory is relative to the
14
16
# documentation root, use os.path.abspath to make it absolute, like shown here.
15
# sys.path.append(os.path.abspath('.'))
17
#sys.path.append(os.path.abspath('.'))
18
20
# -- General configuration -----------------------------------------------------
20
22
# Add any Sphinx extension module names here, as strings. They can be extensions
21
23
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
23
'sphinx.ext.ifconfig',
25
'sphinx.ext.intersphinx',
27
# 'sphinxcontrib.napoleon', # TODO: for Google docstrings
24
extensions = ['sphinx.ext.ifconfig',]
30
26
# Add any paths that contain templates here, relative to this directory.
31
27
templates_path = ['_templates']
40
36
master_doc = 'index'
42
38
# General information about the project.
44
copyright = u'2009-2011 Canonical Ltd, 2017-2018 Breezy Developers'
40
copyright = u'2009-2011 Canonical Ltd'
46
42
# The version info for the project you're documenting, acts as replacement for
47
43
# |version| and |release|, also used in various other places throughout the
50
46
# The short X.Y version.
52
version = '.'.join(str(p) for p in breezy.version_info[:2])
48
version = '.'.join(str(p) for p in brzlib.version_info[:2])
53
49
# The full version, including alpha/beta/rc tags.
54
release = breezy.version_string
50
release = brzlib.version_string
56
52
# The language for content autogenerated by Sphinx. Refer to documentation
57
53
# for a list of supported languages.
96
92
# The theme to use for HTML and HTML Help pages. Major themes that come with
97
93
# Sphinx are currently 'default' and 'sphinxdoc'.
94
html_theme = 'default'
100
96
# Theme options are theme-specific and customize the look and feel of a theme
101
97
# further. For a list of options available for each theme, see the
104
100
# Unfortunately, the right sidebar breaks under IE6 and maybe IE7.
105
101
# So we stick with the default left placement to cater for users stuck
106
102
# on those browsers.
107
# 'rightsidebar': True,
103
#'rightsidebar': True,
109
105
# Non-document areas: header (relbar), footer, sidebar, etc.
110
106
# Some useful colours here:
111
107
# * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
113
109
# * gray: dimgray, slategray, lightslategray
114
#'sidebarbgcolor': "cornflowerblue",
115
#'sidebarlinkcolor': "midnightblue",
116
#'relbarbgcolor': "darkblue",
117
#'footerbgcolor': "lightslategray",
110
'sidebarbgcolor': "cornflowerblue",
111
'sidebarlinkcolor': "midnightblue",
112
'relbarbgcolor': "darkblue",
113
'footerbgcolor': "lightslategray",
119
115
# Text, heading and code colouring
120
#'codebgcolor': "lightyellow",
121
#'codetextcolor': "firebrick",
122
#'linkcolor': "mediumblue",
116
'codebgcolor': "lightyellow",
117
'codetextcolor': "firebrick",
118
'linkcolor': "mediumblue",
125
121
# Add any paths that contain custom themes here, relative to this directory.
139
135
# The name of an image file (within the static path) to use as favicon of the
140
136
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
142
# TODO(jelmer): add a brz.ico
143
# html_favicon = "brz.ico"
138
html_favicon = "bzr.ico"
145
140
# Add any paths that contain custom static files (such as style sheets) here,
146
141
# relative to this directory. They are copied after the builtin static files,
201
196
# The name of an image file (relative to this directory) to place at the top of
202
197
# the title page.
203
# latex_logo = '../Bazaar-Logo-For-Manuals.png'
198
latex_logo = '../Bazaar-Logo-For-Manuals.png'
205
200
# For "manual" documents, if this is true, then toplevel headings are parts,
219
214
# -- Bazaar-specific configuration ---------------------------------------------
221
216
# Authors of the documents
222
brz_team = u'Breezy Developers'
224
intersphinx_mapping = {
225
'python': ('https://docs.python.org/3', None),
226
'testtools': ('https://testtools.readthedocs.io/en/latest', None),
227
'configobj': ('https://configobj.readthedocs.io/en/latest', None),
228
'dulwich': ('https://dulwich.readthedocs.io/en/latest', None),
217
bzr_team = u'Bazaar Developers'