1# -*- coding: utf-8 -*- 2# 3# Elasticsearch documentation build configuration file, created by 4# sphinx-quickstart on Mon May 6 15:38:41 2013. 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 21# -- General configuration ----------------------------------------------------- 22 23# If your documentation needs a minimal Sphinx version, state it here. 24#needs_sphinx = '1.0' 25 26# Add any Sphinx extension module names here, as strings. They can be extensions 27# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] 29 30autoclass_content = "both" 31 32# Add any paths that contain templates here, relative to this directory. 33templates_path = ['_templates'] 34 35# The suffix of source filenames. 36source_suffix = '.rst' 37 38# The encoding of source files. 39#source_encoding = 'utf-8-sig' 40 41# The master toctree document. 42master_doc = 'index' 43 44# General information about the project. 45project = u'Elasticsearch' 46copyright = u'2013, Honza Král' 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 53import elasticsearch 54# The short X.Y version. 55version = elasticsearch.__versionstr__ 56# The full version, including alpha/beta/rc tags. 57release = version 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. 71exclude_patterns = ['_build'] 72 73# The reST default role (used for this markup: `text`) to use for all documents. 74#default_role = None 75 76# If true, '()' will be appended to :func: etc. cross-reference text. 77#add_function_parentheses = True 78 79# If true, the current module name will be prepended to all description 80# unit titles (such as .. function::). 81#add_module_names = True 82 83# If true, sectionauthor and moduleauthor directives will be shown in the 84# output. They are ignored by default. 85#show_authors = False 86 87# The name of the Pygments (syntax highlighting) style to use. 88pygments_style = 'sphinx' 89 90# A list of ignored prefixes for module index sorting. 91#modindex_common_prefix = [] 92 93# If true, keep warnings as "system message" paragraphs in the built documents. 94#keep_warnings = False 95 96 97# -- Options for HTML output --------------------------------------------------- 98 99# The theme to use for HTML and HTML Help pages. See the documentation for 100# a list of builtin themes. 101 102on_rtd = os.environ.get('READTHEDOCS', None) == 'True' 103 104if not on_rtd: # only import and set the theme if we're building docs locally 105 import sphinx_rtd_theme 106 html_theme = 'sphinx_rtd_theme' 107 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] 108 109# Theme options are theme-specific and customize the look and feel of a theme 110# further. For a list of options available for each theme, see the 111# documentation. 112 113# Theme options are theme-specific and customize the look and feel of a theme 114# further. For a list of options available for each theme, see the 115# documentation. 116#html_theme_options = {} 117 118# Add any paths that contain custom themes here, relative to this directory. 119#html_theme_path = [] 120 121# The name for this set of Sphinx documents. If None, it defaults to 122# "<project> v<release> documentation". 123#html_title = None 124 125# A shorter title for the navigation bar. Default is the same as html_title. 126#html_short_title = None 127 128# The name of an image file (relative to this directory) to place at the top 129# of the sidebar. 130#html_logo = None 131 132# The name of an image file (within the static path) to use as favicon of the 133# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 134# pixels large. 135#html_favicon = None 136 137# Add any paths that contain custom static files (such as style sheets) here, 138# relative to this directory. They are copied after the builtin static files, 139# so a file named "default.css" will overwrite the builtin "default.css". 140html_static_path = ['_static'] 141 142# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 143# using the given strftime format. 144#html_last_updated_fmt = '%b %d, %Y' 145 146# If true, SmartyPants will be used to convert quotes and dashes to 147# typographically correct entities. 148#html_use_smartypants = True 149 150# Custom sidebar templates, maps document names to template names. 151#html_sidebars = {} 152 153# Additional templates that should be rendered to pages, maps page names to 154# template names. 155#html_additional_pages = {} 156 157# If false, no module index is generated. 158#html_domain_indices = True 159 160# If false, no index is generated. 161#html_use_index = True 162 163# If true, the index is split into individual pages for each letter. 164#html_split_index = False 165 166# If true, links to the reST sources are added to the pages. 167#html_show_sourcelink = True 168 169# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 170#html_show_sphinx = True 171 172# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 173#html_show_copyright = True 174 175# If true, an OpenSearch description file will be output, and all pages will 176# contain a <link> tag referring to it. The value of this option must be the 177# base URL from which the finished HTML is served. 178#html_use_opensearch = '' 179 180# This is the file name suffix for HTML files (e.g. ".xhtml"). 181#html_file_suffix = None 182 183# Output file base name for HTML help builder. 184htmlhelp_basename = 'Elasticsearchdoc' 185 186 187# -- Options for LaTeX output -------------------------------------------------- 188 189latex_elements = { 190# The paper size ('letterpaper' or 'a4paper'). 191#'papersize': 'letterpaper', 192 193# The font size ('10pt', '11pt' or '12pt'). 194#'pointsize': '10pt', 195 196# Additional stuff for the LaTeX preamble. 197#'preamble': '', 198} 199 200# Grouping the document tree into LaTeX files. List of tuples 201# (source start file, target name, title, author, documentclass [howto/manual]). 202latex_documents = [ 203 ('index', 'Elasticsearch.tex', u'Elasticsearch Documentation', 204 u'Honza Král', 'manual'), 205] 206 207# The name of an image file (relative to this directory) to place at the top of 208# the title page. 209#latex_logo = None 210 211# For "manual" documents, if this is true, then toplevel headings are parts, 212# not chapters. 213#latex_use_parts = False 214 215# If true, show page references after internal links. 216#latex_show_pagerefs = False 217 218# If true, show URL addresses after external links. 219#latex_show_urls = False 220 221# Documents to append as an appendix to all manuals. 222#latex_appendices = [] 223 224# If false, no module index is generated. 225#latex_domain_indices = True 226 227 228# -- Options for manual page output -------------------------------------------- 229 230# One entry per manual page. List of tuples 231# (source start file, name, description, authors, manual section). 232man_pages = [ 233 ('index', 'elasticsearch-py', u'Elasticsearch Documentation', 234 [u'Honza Král'], 1) 235] 236 237# If true, show URL addresses after external links. 238#man_show_urls = False 239 240 241# -- Options for Texinfo output ------------------------------------------------ 242 243# Grouping the document tree into Texinfo files. List of tuples 244# (source start file, target name, title, author, 245# dir menu entry, description, category) 246texinfo_documents = [ 247 ('index', 'Elasticsearch', u'Elasticsearch Documentation', 248 u'Honza Král', 'Elasticsearch', 'One line description of project.', 249 'Miscellaneous'), 250] 251 252# Documents to append as an appendix to all manuals. 253#texinfo_appendices = [] 254 255# If false, no module index is generated. 256#texinfo_domain_indices = True 257 258# How to display URL addresses: 'footnote', 'no', or 'inline'. 259#texinfo_show_urls = 'footnote' 260 261# If true, do not generate a @detailmenu in the "Top" node's menu. 262#texinfo_no_detailmenu = False 263