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 14import 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 21sys.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. 30extensions = ['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. 35templates_path = ['_templates'] 36 37# The suffix of source filenames. 38source_suffix = '.rst' 39 40# The encoding of source files. 41#source_encoding = 'utf-8-sig' 42 43# The master toctree document. 44master_doc = 'index' 45 46# General information about the project. 47project = u'Percona Server' 48copyright = u'Percona LLC and/or its affiliates 2009-2021' 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. 55version = '5.7' 56# The full version, including alpha/beta/rc tags. 57release = '5.7.35-38' 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 patterns, relative to source directory, that match files and 69# directories to ignore when looking for source files. 70exclude_patterns = [] 71 72# The reST default role (used for this markup: `text`) to use for all documents. 73#default_role = None 74 75primary_domain = 'psdom' 76 77# If true, '()' will be appended to :func: etc. cross-reference text. 78#add_function_parentheses = True 79 80# If true, the current module name will be prepended to all description 81# unit titles (such as .. function::). 82#add_module_names = True 83 84# If true, sectionauthor and moduleauthor directives will be shown in the 85# output. They are ignored by default. 86#show_authors = False 87 88# The name of the Pygments (syntax highlighting) style to use. 89pygments_style = 'sphinx' 90 91rst_prolog = ''' 92 93.. role:: mysql(code) 94 :language: mysql 95 96.. role:: dir(file) 97 98.. role:: bash(code) 99 :language: bash 100 101.. |check| replace:: ``|[[---CHECK---]]|`` 102 103.. |xtrabackup| replace:: :program:`xtrabackup` 104 105.. |innobackupex| replace:: :program:`innobackupex` 106 107.. |XtraDB| replace:: *XtraDB* 108 109.. |Jenkins| replace:: :term:`Jenkins` 110 111.. |InnoDB| replace:: *InnoDB* 112 113.. |MyISAM| replace:: *MyISAM* 114 115.. |LSN| replace:: *LSN* 116 117.. |XtraBackup| replace:: *XtraBackup* 118 119.. |Percona XtraBackup| replace:: *Percona XtraBackup* 120 121.. |Percona TokuBackup| replace:: *Percona TokuBackup* 122 123.. |TokuBackup| replace:: *TokuBackup* 124 125.. |Percona Toolkit| replace:: *Percona Toolkit* 126 127.. |Percona Server| replace:: *Percona Server for MySQL* 128 129.. |Percona| replace:: *Percona* 130 131.. |TokuDB| replace:: *TokuDB* 132 133.. |Percona FT| replace:: *Percona FT* 134 135.. |MySQL| replace:: *MySQL* 136 137.. |MariaDB| replace:: *MariaDB* 138 139.. |tar4ibd| replace:: :program:`tar4ibd` 140 141.. |tar| replace:: :program:`tar` 142 143.. |MyRocks| replace:: *MyRocks* 144 145''' 146 147# A list of ignored prefixes for module index sorting. 148#modindex_common_prefix = [] 149 150extlinks = {'bug': ('https://bugs.launchpad.net/percona-server/+bug/%s', '#'), 151 'mysqlbug': ('http://bugs.mysql.com/bug.php?id=%s', '#'), 152 'ftbug': ('https://tokutek.atlassian.net/browse/FT-%s', '#'), 153 'tokubug': ('https://tokutek.atlassian.net/browse/DB-%s', '#'), 154 'backupbug': ('https://tokutek.atlassian.net/browse/BACKUP-%s', '#'), 155 'tdbbug': ('https://jira.percona.com/browse/TDB-%s', '#'), 156 'psbug': ('https://jira.percona.com/browse/PS-%s', '#'), 157 'jirabug': ('https://jira.percona.com/browse/%s', '') 158} 159 160 161# -- Options for HTML output --------------------------------------------------- 162 163# The theme to use for HTML and HTML Help pages. See the documentation for 164# a list of builtin themes. 165html_theme = 'percona-theme' 166 167# Theme options are theme-specific and customize the look and feel of a theme 168# further. For a list of options available for each theme, see the 169# documentation. 170#html_theme_options = {} 171 172# Add any paths that contain custom themes here, relative to this directory. 173html_theme_path = ['.', './percona-theme'] 174 175# The name for this set of Sphinx documents. If None, it defaults to 176# "<project> v<release> documentation". 177html_title = ' '.join([project, version, 'Documentation']) 178 179# A shorter title for the navigation bar. Default is the same as html_title. 180html_short_title = ' '.join([project, version]) 181 182# The name of an image file (relative to this directory) to place at the top 183# of the sidebar. 184html_logo = 'percona-server-logo.jpg' 185 186# The name of an image file (within the static path) to use as favicon of the 187# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 188# pixels large. 189#html_favicon = None 190 191# Add any paths that contain custom static files (such as style sheets) here, 192# relative to this directory. They are copied after the builtin static files, 193# so a file named "default.css" will overwrite the builtin "default.css". 194html_static_path = ['_static'] 195 196# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 197# using the given strftime format. 198#html_last_updated_fmt = '%b %d, %Y' 199 200# If true, SmartyPants will be used to convert quotes and dashes to 201# typographically correct entities. 202#html_use_smartypants = True 203 204# Custom sidebar templates, maps document names to template names. 205html_sidebars = { 206 '**': ['localtoc.html', 'sourcelink.html'], 207 'using/windows': ['windowssidebar.html'], 208} 209 210# Additional templates that should be rendered to pages, maps page names to 211# template names. 212#html_additional_pages = {} 213 214# If false, no module index is generated. 215#html_domain_indices = True 216 217# If false, no index is generated. 218#html_use_index = True 219 220# If true, the index is split into individual pages for each letter. 221#html_split_index = False 222 223# If true, links to the reST sources are added to the pages. 224#html_show_sourcelink = True 225 226# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 227#html_show_sphinx = True 228 229# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 230#html_show_copyright = True 231 232# If true, an OpenSearch description file will be output, and all pages will 233# contain a <link> tag referring to it. The value of this option must be the 234# base URL from which the finished HTML is served. 235#html_use_opensearch = '' 236 237# This is the file name suffix for HTML files (e.g. ".xhtml"). 238#html_file_suffix = None 239 240# Output file base name for HTML help builder. 241# Base name: project without whitespace; 242# version without the dot; 243# doc 244# Base name example: PerconaServer57doc 245 246# Tip: To see the value assigned to the following variable, copy the 247# expression to be assigned and evaluate it in Python3 schell. 248 249htmlhelp_basename = 'PerconaServer57doc' 250 251# -- Options for LaTeX output -------------------------------------------------- 252 253# The paper size ('letter' or 'a4'). 254#latex_paper_size = 'letter' 255 256# The font size ('10pt', '11pt' or '12pt'). 257#latex_font_size = '10pt' 258 259# Grouping the document tree into LaTeX files. List of tuples 260# (source start file, target name (example: 'PerconaServer-5.7.tex'), 261# title, author, documentclass [howto/manual]). 262 263# Tip: To see the value assigned to the following variable, copy the 264# expression to be assigned and evaluate it in Python3 schell. 265 266latex_documents = [ 267 ('index', 'PerconaServer-5.7.tex', u'Percona Server for MySQL Documentation', 268 u'Percona LLC and/or its affiliates 2009-2021', 'manual'), 269] 270 271# The name of an image file (relative to this directory) to place at the top of 272# the title page. 273latex_logo = 'percona-logo.jpg' 274 275# For "manual" documents, if this is true, then toplevel headings are parts, 276# not chapters. 277latex_toplevel_sectioning = 'part' 278 279latex_elements = { 280 'classoptions': ',oneside', 281 'babel': '\\usepackage[english]{babel}' 282} 283 284# If true, show page references after internal links. 285#latex_show_pagerefs = False 286 287# If true, show URL addresses after external links. 288#latex_show_urls = False 289 290# Additional stuff for the LaTeX preamble. 291#latex_preamble = '' 292 293# Documents to append as an appendix to all manuals. 294#latex_appendices = [] 295 296# If false, no module index is generated. 297#latex_domain_indices = True 298 299 300# -- Options for manual page output -------------------------------------------- 301 302# One entry per manual page. List of tuples 303# (source start file, name, description, authors, manual section). 304 305# Tip: To see the value assigned to the following variable, copy the 306# expression to be assigned and evaluate it in Python3 schell. 307 308man_pages = [ 309 ('index', 'perconaserver57', u'Percona Server for MySQL 5.7 Documentation', 310 [u'Percona LLC and/or its affiliates 2009-2021'], 1) 311] 312 313 314# Example configuration for intersphinx: refer to the Python standard library. 315intersphinx_mapping = { 316 'ps51' : ('https://www.percona.com/doc/percona-server/5.1/', None), 317 'ps55' : ('https://www.percona.com/doc/percona-server/5.5/', None), 318 'ps56' : ('https://www.percona.com/doc/percona-server/5.6/', None), 319 'ps57' : ('https://www.percona.com/doc/percona-server/5.7/', None), 320 'ps80' : ('https://www.percona.com/doc/percona-server/8.0/', None), 321 'xb21' : ('https://www.percona.com/doc/percona-xtrabackup/2.1/', None), 322 'ptoolkit' : ('https://www.percona.com/doc/percona-toolkit/2.2/', None) 323 } 324