/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 bzrlib/doc_generate/sphinx_conf.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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