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