/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/doc_generate/conf.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2020-08-23 01:15:41 UTC
  • mfrom: (7520.1.4 merge-3.1)
  • Revision ID: breezy.the.bot@gmail.com-20200823011541-nv0oh7nzaganx2qy
Merge lp:brz/3.1.

Merged from https://code.launchpad.net/~jelmer/brz/merge-3.1/+merge/389690

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/doc_generate/conf.py
6
6
# All configuration values have a default; values that are commented out
7
7
# serve to show the default.
8
8
 
9
 
import sys, os
 
9
# FIXME: better move the content of doc/en/conf.py here and cleanup the result
 
10
# -- vila 20100428
10
11
 
11
12
# If extensions (or modules to document with autodoc) are in another directory,
12
13
# add these directories to sys.path here. If the directory is relative to the
13
14
# documentation root, use os.path.abspath to make it absolute, like shown here.
14
 
#sys.path.append(os.path.abspath('.'))
 
15
# sys.path.append(os.path.abspath('.'))
15
16
 
16
17
 
17
18
# -- General configuration -----------------------------------------------------
18
19
 
19
20
# Add any Sphinx extension module names here, as strings. They can be extensions
20
21
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
21
 
extensions = ['sphinx.ext.ifconfig']
 
22
extensions = [
 
23
    'sphinx.ext.ifconfig',
 
24
    'sphinx.ext.autodoc',
 
25
    'sphinx.ext.intersphinx',
 
26
    'sphinx_epytext',
 
27
    # 'sphinxcontrib.napoleon', # TODO: for Google docstrings
 
28
    ]
22
29
 
23
30
# Add any paths that contain templates here, relative to this directory.
24
31
templates_path = ['_templates']
33
40
master_doc = 'index'
34
41
 
35
42
# General information about the project.
36
 
project = u'Bazaar'
37
 
copyright = u'2009, Canonical Ltd'
 
43
project = u'Breezy'
 
44
copyright = u'2009-2011 Canonical Ltd, 2017-2018 Breezy Developers'
38
45
 
39
46
# The version info for the project you're documenting, acts as replacement for
40
47
# |version| and |release|, also used in various other places throughout the
41
48
# built documents.
42
49
#
43
50
# The short X.Y version.
44
 
import bzrlib
45
 
version = '.'.join(str(p) for p in bzrlib.version_info[:2])
 
51
import breezy
 
52
version = '.'.join(str(p) for p in breezy.version_info[:2])
46
53
# The full version, including alpha/beta/rc tags.
47
 
release = bzrlib.version_string
 
54
release = breezy.version_string
48
55
 
49
56
# The language for content autogenerated by Sphinx. Refer to documentation
50
57
# for a list of supported languages.
88
95
 
89
96
# The theme to use for HTML and HTML Help pages.  Major themes that come with
90
97
# Sphinx are currently 'default' and 'sphinxdoc'.
91
 
html_theme = 'default'
 
98
html_theme = 'agogo'
92
99
 
93
100
# Theme options are theme-specific and customize the look and feel of a theme
94
101
# further.  For a list of options available for each theme, see the
97
104
    # Unfortunately, the right sidebar breaks under IE6 and maybe IE7.
98
105
    # So we stick with the default left placement to cater for users stuck
99
106
    # on those browsers.
100
 
    #'rightsidebar': True,
 
107
    # 'rightsidebar': True,
101
108
 
102
109
    # Non-document areas: header (relbar), footer, sidebar, etc.
103
110
    # Some useful colours here:
104
111
    # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
105
112
    #   midnightblue
106
113
    # * gray: dimgray, slategray, lightslategray
107
 
    'sidebarbgcolor':   "cornflowerblue",
108
 
    'sidebarlinkcolor': "midnightblue",
109
 
    'relbarbgcolor':    "darkblue",
110
 
    'footerbgcolor':    "lightslategray",
 
114
    #'sidebarbgcolor': "cornflowerblue",
 
115
    #'sidebarlinkcolor': "midnightblue",
 
116
    #'relbarbgcolor': "darkblue",
 
117
    #'footerbgcolor': "lightslategray",
111
118
 
112
119
    # Text, heading and code colouring
113
 
    'codebgcolor':      "lightyellow",
114
 
    'codetextcolor':    "firebrick",
115
 
    'linkcolor':        "mediumblue",
 
120
    #'codebgcolor': "lightyellow",
 
121
    #'codetextcolor': "firebrick",
 
122
    #'linkcolor': "mediumblue",
116
123
    }
117
124
 
118
125
# Add any paths that contain custom themes here, relative to this directory.
132
139
# The name of an image file (within the static path) to use as favicon of the
133
140
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
134
141
# pixels large.
135
 
html_favicon = "bzr.ico"
 
142
# TODO(jelmer): add a brz.ico
 
143
# html_favicon = "brz.ico"
136
144
 
137
145
# Add any paths that contain custom static files (such as style sheets) here,
138
146
# relative to this directory. They are copied after the builtin static files,
175
183
#html_file_suffix = ''
176
184
 
177
185
# Output file base name for HTML help builder.
178
 
htmlhelp_basename = 'bzr-docs'
 
186
htmlhelp_basename = 'brz-docs'
179
187
 
180
188
 
181
189
# -- Options for LaTeX output --------------------------------------------------
192
200
 
193
201
# The name of an image file (relative to this directory) to place at the top of
194
202
# the title page.
195
 
latex_logo = '../Bazaar-Logo-For-Manuals.png'
 
203
# latex_logo = '../Bazaar-Logo-For-Manuals.png'
196
204
 
197
205
# For "manual" documents, if this is true, then toplevel headings are parts,
198
206
# not chapters.
211
219
# -- Bazaar-specific configuration ---------------------------------------------
212
220
 
213
221
# Authors of the documents
214
 
bzr_team = u'Bazaar Developers'
 
222
brz_team = u'Breezy Developers'
 
223
 
 
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),
 
229
}