← Back to branch summary

~vlad-lesin/percona-server/5.5-bug1049871-injections

« back to all changes in this revision

Viewing changes to doc/source/conf.py

merge theme-makefile-5.1 from 5.1 tree. This basically reconciles different file ids for some of the documentation files

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/conf.py
1
 
# -*- coding: utf-8 -*-
2
 
#
3
 
# Percona Server documentation build configuration file, created by
4
 
# sphinx-quickstart on Mon Aug  8 01:24:46 2011.
5
 
#
6
 
# This file is execfile()d with the current directory set to its containing dir.
7
 
#
8
 
# Note that not all possible configuration values are present in this
9
 
# autogenerated file.
10
 
#
11
 
# All configuration values have a default; values that are commented out
12
 
# serve to show the default.
13
 
 
14
 
import sys, os
15
 
 
16
 
# If extensions (or modules to document with autodoc) are in another directory,
17
 
# add these directories to sys.path here. If the directory is relative to the
18
 
# documentation root, use os.path.abspath to make it absolute, like shown here.
19
 
#sys.path.insert(0, os.path.abspath('.'))
20
 
 
21
 
sys.path.append(os.path.abspath('ext'))
22
 
 
23
 
# -- General configuration -----------------------------------------------------
24
 
 
25
 
# If your documentation needs a minimal Sphinx version, state it here.
26
 
#needs_sphinx = '1.0'
27
 
 
28
 
# Add any Sphinx extension module names here, as strings. They can be extensions
29
 
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30
 
extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 
31
 
              'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 
32
 
              'sphinx.ext.extlinks', 'psdom']
33
 
 
34
 
# Add any paths that contain templates here, relative to this directory.
35
 
templates_path = ['_templates']
36
 
 
37
 
# The suffix of source filenames.
38
 
source_suffix = '.rst'
39
 
 
40
 
# The encoding of source files.
41
 
#source_encoding = 'utf-8-sig'
42
 
 
43
 
# The master toctree document.
44
 
master_doc = 'index'
45
 
 
46
 
# General information about the project.
47
 
project = u'Percona Server'
48
 
copyright = u'2011-2012, Percona Inc'
49
 
 
50
 
# The version info for the project you're documenting, acts as replacement for
51
 
# |version| and |release|, also used in various other places throughout the
52
 
# built documents.
53
 
#
54
 
# The short X.Y version.
55
 
version = '5.5'
56
 
# The full version, including alpha/beta/rc tags.
57
 
release = '5.5.25a-27.1'
58
 
 
59
 
# The language for content autogenerated by Sphinx. Refer to documentation
60
 
# for a list of supported languages.
61
 
#language = None
62
 
 
63
 
# There are two options for replacing |today|: either, you set today to some
64
 
# non-false value, then it is used:
65
 
#today = ''
66
 
# Else, today_fmt is used as the format for a strftime call.
67
 
#today_fmt = '%B %d, %Y'
68
 
 
69
 
# List of patterns, relative to source directory, that match files and
70
 
# directories to ignore when looking for source files.
71
 
exclude_patterns = []
72
 
 
73
 
# The reST default role (used for this markup: `text`) to use for all documents.
74
 
#default_role = None
75
 
 
76
 
primary_domain = 'psdom'
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
 
rst_prolog = '''
93
 
.. |check|  replace:: ``|[[---CHECK---]]|``
94
 
 
95
 
.. |xtrabackup|  replace:: :program:`xtrabackup`
96
 
 
97
 
.. |innobackupex|  replace:: :program:`innobackupex`
98
 
 
99
 
.. |XtraDB|  replace:: *XtraDB*
100
 
 
101
 
.. |Jenkins|  replace:: :term:`Jenkins`
102
 
 
103
 
.. |InnoDB|  replace:: *InnoDB*
104
 
 
105
 
.. |MyISAM|  replace:: *MyISAM*
106
 
 
107
 
.. |LSN|  replace:: *LSN*
108
 
 
109
 
.. |XtraBackup|  replace:: *XtraBackup*
110
 
 
111
 
.. |Percona Server|  replace:: *Percona Server*
112
 
 
113
 
.. |Percona|  replace:: *Percona*
114
 
 
115
 
.. |MySQL|  replace:: *MySQL*
116
 
 
117
 
.. |Drizzle|  replace:: *Drizzle*
118
 
 
119
 
.. |MariaDB|  replace:: *MariaDB*
120
 
 
121
 
.. |tar4ibd|  replace:: :program:`tar4ibd`
122
 
 
123
 
.. |tar|  replace:: :program:`tar`
124
 
 
125
 
'''
126
 
 
127
 
# A list of ignored prefixes for module index sorting.
128
 
#modindex_common_prefix = []
129
 
 
130
 
extlinks = {'bug': ('https://bugs.launchpad.net/percona-server/+bug/%s',
131
 
                      '#')}
132
 
 
133
 
 
134
 
# -- Options for HTML output ---------------------------------------------------
135
 
 
136
 
# The theme to use for HTML and HTML Help pages.  See the documentation for
137
 
# a list of builtin themes.
138
 
html_theme = 'percona-theme'
139
 
 
140
 
# Theme options are theme-specific and customize the look and feel of a theme
141
 
# further.  For a list of options available for each theme, see the
142
 
# documentation.
143
 
#html_theme_options = {}
144
 
 
145
 
# Add any paths that contain custom themes here, relative to this directory.
146
 
html_theme_path = ['.', './percona-theme']
147
 
 
148
 
# The name for this set of Sphinx documents.  If None, it defaults to
149
 
# "<project> v<release> documentation".
150
 
html_title = 'Percona Server 5.5 Documentation'
151
 
 
152
 
# A shorter title for the navigation bar.  Default is the same as html_title.
153
 
html_short_title = 'Percona Server 5.5'
154
 
 
155
 
# The name of an image file (relative to this directory) to place at the top
156
 
# of the sidebar.
157
 
html_logo = 'percona-server-logo.jpg'
158
 
 
159
 
# The name of an image file (within the static path) to use as favicon of the
160
 
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
161
 
# pixels large.
162
 
#html_favicon = None
163
 
 
164
 
# Add any paths that contain custom static files (such as style sheets) here,
165
 
# relative to this directory. They are copied after the builtin static files,
166
 
# so a file named "default.css" will overwrite the builtin "default.css".
167
 
html_static_path = ['_static']
168
 
 
169
 
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
170
 
# using the given strftime format.
171
 
#html_last_updated_fmt = '%b %d, %Y'
172
 
 
173
 
# If true, SmartyPants will be used to convert quotes and dashes to
174
 
# typographically correct entities.
175
 
#html_use_smartypants = True
176
 
 
177
 
# Custom sidebar templates, maps document names to template names.
178
 
#html_sidebars = {}
179
 
 
180
 
# Additional templates that should be rendered to pages, maps page names to
181
 
# template names.
182
 
#html_additional_pages = {}
183
 
 
184
 
# If false, no module index is generated.
185
 
#html_domain_indices = True
186
 
 
187
 
# If false, no index is generated.
188
 
#html_use_index = True
189
 
 
190
 
# If true, the index is split into individual pages for each letter.
191
 
#html_split_index = False
192
 
 
193
 
# If true, links to the reST sources are added to the pages.
194
 
#html_show_sourcelink = True
195
 
 
196
 
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
197
 
#html_show_sphinx = True
198
 
 
199
 
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
200
 
#html_show_copyright = True
201
 
 
202
 
# If true, an OpenSearch description file will be output, and all pages will
203
 
# contain a <link> tag referring to it.  The value of this option must be the
204
 
# base URL from which the finished HTML is served.
205
 
#html_use_opensearch = ''
206
 
 
207
 
# This is the file name suffix for HTML files (e.g. ".xhtml").
208
 
#html_file_suffix = None
209
 
 
210
 
# Output file base name for HTML help builder.
211
 
htmlhelp_basename = 'PerconaServer55doc'
212
 
 
213
 
 
214
 
# -- Options for LaTeX output --------------------------------------------------
215
 
 
216
 
# The paper size ('letter' or 'a4').
217
 
#latex_paper_size = 'letter'
218
 
 
219
 
# The font size ('10pt', '11pt' or '12pt').
220
 
#latex_font_size = '10pt'
221
 
 
222
 
# Grouping the document tree into LaTeX files. List of tuples
223
 
# (source start file, target name, title, author, documentclass [howto/manual]).
224
 
latex_documents = [
225
 
  ('index', 'PerconaServer-5.5.tex', u'Percona Server Documentation',
226
 
   u'Percona Inc', 'manual'),
227
 
]
228
 
 
229
 
# The name of an image file (relative to this directory) to place at the top of
230
 
# the title page.
231
 
#latex_logo = None
232
 
 
233
 
# For "manual" documents, if this is true, then toplevel headings are parts,
234
 
# not chapters.
235
 
#latex_use_parts = False
236
 
 
237
 
# If true, show page references after internal links.
238
 
#latex_show_pagerefs = False
239
 
 
240
 
# If true, show URL addresses after external links.
241
 
#latex_show_urls = False
242
 
 
243
 
# Additional stuff for the LaTeX preamble.
244
 
#latex_preamble = ''
245
 
 
246
 
# Documents to append as an appendix to all manuals.
247
 
#latex_appendices = []
248
 
 
249
 
# If false, no module index is generated.
250
 
#latex_domain_indices = True
251
 
 
252
 
 
253
 
# -- Options for manual page output --------------------------------------------
254
 
 
255
 
# One entry per manual page. List of tuples
256
 
# (source start file, name, description, authors, manual section).
257
 
man_pages = [
258
 
    ('index', 'perconaserver55', u'Percona Server 5.5 Documentation',
259
 
     [u'Percona Inc'], 1)
260
 
]
261
 
 
262
 
 
263
 
# Example configuration for intersphinx: refer to the Python standard library.
264
 
intersphinx_mapping = {
265
 
    'ps51' : ('http://www.percona.com/doc/percona-server/5.1/', None),
266
 
    'xtrabackup' : ('http://www.percona.com/doc/percona-xtrabackup', None),
267
 
    'ptoolkit' : ('http://www.percona.com/doc/percona-toolkit/2.0/', None)
268
 
 }