/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: Robert Collins
  • Date: 2005-10-19 10:11:57 UTC
  • mfrom: (1185.16.78)
  • mto: This revision was merged to the branch mainline in revision 1470.
  • Revision ID: robertc@robertcollins.net-20051019101157-17438d311e746b4f
merge from upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/doc_generate/conf.py
1
 
# -*- coding: utf-8 -*-
2
 
#
3
 
# Bazaar documentation build configuration file, created by
4
 
# sphinx-quickstart on Tue Jul 21 17:04:52 2009.
5
 
#
6
 
# All configuration values have a default; values that are commented out
7
 
# serve to show the default.
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
13
 
 
14
 
# If extensions (or modules to document with autodoc) are in another directory,
15
 
# add these directories to sys.path here. If the directory is relative to the
16
 
# documentation root, use os.path.abspath to make it absolute, like shown here.
17
 
# sys.path.append(os.path.abspath('.'))
18
 
 
19
 
 
20
 
# -- General configuration -----------------------------------------------------
21
 
 
22
 
# Add any Sphinx extension module names here, as strings. They can be extensions
23
 
# 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
 
    ]
31
 
 
32
 
# Add any paths that contain templates here, relative to this directory.
33
 
templates_path = ['_templates']
34
 
 
35
 
# The suffix of source filenames.
36
 
source_suffix = '.txt'
37
 
 
38
 
# The encoding of source files.
39
 
#source_encoding = 'utf-8'
40
 
 
41
 
# The master toctree document.
42
 
master_doc = 'index'
43
 
 
44
 
# General information about the project.
45
 
project = u'Breezy'
46
 
copyright = u'2009-2011 Canonical Ltd, 2017-2018 Breezy Developers'
47
 
 
48
 
# The version info for the project you're documenting, acts as replacement for
49
 
# |version| and |release|, also used in various other places throughout the
50
 
# built documents.
51
 
#
52
 
# The short X.Y version.
53
 
import breezy
54
 
version = '.'.join(str(p) for p in breezy.version_info[:2])
55
 
# The full version, including alpha/beta/rc tags.
56
 
release = breezy.version_string
57
 
 
58
 
# The language for content autogenerated by Sphinx. Refer to documentation
59
 
# for a list of supported languages.
60
 
#language = None
61
 
 
62
 
# There are two options for replacing |today|: either, you set today to some
63
 
# non-false value, then it is used:
64
 
#today = ''
65
 
# Else, today_fmt is used as the format for a strftime call.
66
 
#today_fmt = '%B %d, %Y'
67
 
 
68
 
# List of documents that shouldn't be included in the build.
69
 
#unused_docs = []
70
 
 
71
 
# List of directories, relative to source directory, that shouldn't be searched
72
 
# for source files.
73
 
exclude_trees = ['_build']
74
 
 
75
 
# The reST default role (used for this markup: `text`) to use for all documents.
76
 
#default_role = None
77
 
 
78
 
# If true, '()' will be appended to :func: etc. cross-reference text.
79
 
#add_function_parentheses = True
80
 
 
81
 
# If true, the current module name will be prepended to all description
82
 
# unit titles (such as .. function::).
83
 
#add_module_names = True
84
 
 
85
 
# If true, sectionauthor and moduleauthor directives will be shown in the
86
 
# output. They are ignored by default.
87
 
#show_authors = False
88
 
 
89
 
# The name of the Pygments (syntax highlighting) style to use.
90
 
pygments_style = 'sphinx'
91
 
 
92
 
# A list of ignored prefixes for module index sorting.
93
 
#modindex_common_prefix = []
94
 
 
95
 
 
96
 
# -- Options for HTML output ---------------------------------------------------
97
 
 
98
 
# The theme to use for HTML and HTML Help pages.  Major themes that come with
99
 
# Sphinx are currently 'default' and 'sphinxdoc'.
100
 
html_theme = 'agogo'
101
 
 
102
 
# Theme options are theme-specific and customize the look and feel of a theme
103
 
# further.  For a list of options available for each theme, see the
104
 
# documentation.
105
 
html_theme_options = {
106
 
    # Unfortunately, the right sidebar breaks under IE6 and maybe IE7.
107
 
    # So we stick with the default left placement to cater for users stuck
108
 
    # on those browsers.
109
 
    # 'rightsidebar': True,
110
 
 
111
 
    # Non-document areas: header (relbar), footer, sidebar, etc.
112
 
    # Some useful colours here:
113
 
    # * blue: darkblue, mediumblue, darkslateblue, cornflowerblue, royalblue,
114
 
    #   midnightblue
115
 
    # * gray: dimgray, slategray, lightslategray
116
 
    #'sidebarbgcolor': "cornflowerblue",
117
 
    #'sidebarlinkcolor': "midnightblue",
118
 
    #'relbarbgcolor': "darkblue",
119
 
    #'footerbgcolor': "lightslategray",
120
 
 
121
 
    # Text, heading and code colouring
122
 
    #'codebgcolor': "lightyellow",
123
 
    #'codetextcolor': "firebrick",
124
 
    #'linkcolor': "mediumblue",
125
 
    }
126
 
 
127
 
# Add any paths that contain custom themes here, relative to this directory.
128
 
#html_theme_path = []
129
 
 
130
 
# The name for this set of Sphinx documents.  If None, it defaults to
131
 
# "<project> v<release> documentation".
132
 
#html_title = None
133
 
 
134
 
# A shorter title for the navigation bar.  Default is the same as html_title.
135
 
#html_short_title = None
136
 
 
137
 
# The name of an image file (relative to this directory) to place at the top
138
 
# of the sidebar.
139
 
#html_logo = None
140
 
 
141
 
# The name of an image file (within the static path) to use as favicon of the
142
 
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
143
 
# pixels large.
144
 
# TODO(jelmer): add a brz.ico
145
 
# html_favicon = "brz.ico"
146
 
 
147
 
# Add any paths that contain custom static files (such as style sheets) here,
148
 
# relative to this directory. They are copied after the builtin static files,
149
 
# so a file named "default.css" will overwrite the builtin "default.css".
150
 
html_static_path = ['_static']
151
 
 
152
 
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
153
 
# using the given strftime format.
154
 
#html_last_updated_fmt = '%b %d, %Y'
155
 
 
156
 
# If true, SmartyPants will be used to convert quotes and dashes to
157
 
# typographically correct entities.
158
 
#html_use_smartypants = True
159
 
 
160
 
# Custom sidebar templates, maps document names to template names.
161
 
#html_sidebars = {}
162
 
 
163
 
# Additional templates that should be rendered to pages, maps page names to
164
 
# template names.
165
 
#html_additional_pages = {}
166
 
 
167
 
# If false, no module index is generated.
168
 
html_use_modindex = False
169
 
 
170
 
# If false, no index is generated.
171
 
html_use_index = False
172
 
 
173
 
# If true, the index is split into individual pages for each letter.
174
 
#html_split_index = False
175
 
 
176
 
# If true, links to the reST sources are added to the pages.
177
 
html_show_sourcelink = True
178
 
 
179
 
# If true, an OpenSearch description file will be output, and all pages will
180
 
# contain a <link> tag referring to it.  The value of this option must be the
181
 
# base URL from which the finished HTML is served.
182
 
#html_use_opensearch = ''
183
 
 
184
 
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
185
 
#html_file_suffix = ''
186
 
 
187
 
# Output file base name for HTML help builder.
188
 
htmlhelp_basename = 'brz-docs'
189
 
 
190
 
 
191
 
# -- Options for LaTeX output --------------------------------------------------
192
 
 
193
 
# The paper size ('letter' or 'a4').
194
 
#latex_paper_size = 'letter'
195
 
 
196
 
# The font size ('10pt', '11pt' or '12pt').
197
 
#latex_font_size = '10pt'
198
 
 
199
 
# Grouping the document tree into LaTeX files. List of tuples
200
 
# (source start file, target name, title, author, documentclass [howto/manual]).
201
 
latex_documents = []
202
 
 
203
 
# The name of an image file (relative to this directory) to place at the top of
204
 
# the title page.
205
 
# latex_logo = '../Bazaar-Logo-For-Manuals.png'
206
 
 
207
 
# For "manual" documents, if this is true, then toplevel headings are parts,
208
 
# not chapters.
209
 
#latex_use_parts = False
210
 
 
211
 
# Additional stuff for the LaTeX preamble.
212
 
#latex_preamble = ''
213
 
 
214
 
# Documents to append as an appendix to all manuals.
215
 
#latex_appendices = []
216
 
 
217
 
# If false, no module index is generated.
218
 
#latex_use_modindex = True
219
 
 
220
 
 
221
 
# -- Bazaar-specific configuration ---------------------------------------------
222
 
 
223
 
# 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
 
}