begin_unit
comment|'# -*- coding: utf-8 -*-'
nl|'\n'
nl|'\n'
comment|'# Licensed under the Apache License, Version 2.0 (the "License");'
nl|'\n'
comment|'# you may not use this file except in compliance with the License.'
nl|'\n'
comment|'# You may obtain a copy of the License at'
nl|'\n'
comment|'#'
nl|'\n'
comment|'#    http://www.apache.org/licenses/LICENSE-2.0'
nl|'\n'
comment|'#'
nl|'\n'
comment|'# Unless required by applicable law or agreed to in writing, software'
nl|'\n'
comment|'# distributed under the License is distributed on an "AS IS" BASIS,'
nl|'\n'
comment|'# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or'
nl|'\n'
comment|'# implied.'
nl|'\n'
comment|'# See the License for the specific language governing permissions and'
nl|'\n'
comment|'# limitations under the License.'
nl|'\n'
comment|'#'
nl|'\n'
comment|'# Compute API documentation build configuration file'
nl|'\n'
comment|'#'
nl|'\n'
comment|'# All configuration values have a default; values that are commented out'
nl|'\n'
comment|'# serve to show the default.'
nl|'\n'
nl|'\n'
comment|'# import sys'
nl|'\n'
name|'import'
name|'subprocess'
newline|'\n'
nl|'\n'
name|'import'
name|'openstackdocstheme'
newline|'\n'
nl|'\n'
comment|'# If extensions (or modules to document with autodoc) are in another directory,'
nl|'\n'
comment|'# add these directories to sys.path here. If the directory is relative to the'
nl|'\n'
comment|'# documentation root, use os.path.abspath to make it absolute, like shown here.'
nl|'\n'
comment|"# sys.path.insert(0, os.path.abspath('.'))"
nl|'\n'
nl|'\n'
comment|'# -- General configuration ------------------------------------------------'
nl|'\n'
nl|'\n'
comment|'# If your documentation needs a minimal Sphinx version, state it here.'
nl|'\n'
comment|"# needs_sphinx = '1.0'"
nl|'\n'
nl|'\n'
comment|'# Add any Sphinx extension module names here, as strings. They can be'
nl|'\n'
comment|"# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom"
nl|'\n'
comment|'# ones.'
nl|'\n'
DECL|variable|extensions
name|'extensions'
op|'='
op|'['
op|']'
newline|'\n'
nl|'\n'
comment|'# Add any paths that contain templates here, relative to this directory.'
nl|'\n'
DECL|variable|templates_path
name|'templates_path'
op|'='
op|'['
string|"'_templates'"
op|']'
newline|'\n'
nl|'\n'
comment|'# The suffix of source filenames.'
nl|'\n'
DECL|variable|source_suffix
name|'source_suffix'
op|'='
string|"'.rst'"
newline|'\n'
nl|'\n'
comment|'# The encoding of source files.'
nl|'\n'
comment|"# source_encoding = 'utf-8-sig'"
nl|'\n'
nl|'\n'
comment|'# The master toctree document.'
nl|'\n'
DECL|variable|master_doc
name|'master_doc'
op|'='
string|"'index'"
newline|'\n'
comment|'# General information about the project.'
nl|'\n'
DECL|variable|project
name|'project'
op|'='
string|"u'Compute API Guide'"
newline|'\n'
DECL|variable|bug_tag
name|'bug_tag'
op|'='
string|"u'api-guide'"
newline|'\n'
nl|'\n'
DECL|variable|copyright
name|'copyright'
op|'='
string|"u'2015, OpenStack contributors'"
newline|'\n'
nl|'\n'
comment|"# The version info for the project you're documenting, acts as replacement for"
nl|'\n'
comment|'# |version| and |release|, also used in various other places throughout the'
nl|'\n'
comment|'# built documents.'
nl|'\n'
comment|'#'
nl|'\n'
comment|'# The short X.Y version.'
nl|'\n'
DECL|variable|version
name|'version'
op|'='
string|"'2.1.0'"
newline|'\n'
comment|'# The full version, including alpha/beta/rc tags.'
nl|'\n'
DECL|variable|release
name|'release'
op|'='
string|"'2.1.0'"
newline|'\n'
nl|'\n'
comment|'# The language for content autogenerated by Sphinx. Refer to documentation'
nl|'\n'
comment|'# for a list of supported languages.'
nl|'\n'
comment|'# language = None'
nl|'\n'
nl|'\n'
comment|'# There are two options for replacing |today|: either, you set today to some'
nl|'\n'
comment|'# non-false value, then it is used:'
nl|'\n'
comment|"# today = ''"
nl|'\n'
comment|'# Else, today_fmt is used as the format for a strftime call.'
nl|'\n'
comment|"# today_fmt = '%B %d, %Y'"
nl|'\n'
nl|'\n'
comment|'# A few variables have to be set for the log-a-bug feature.'
nl|'\n'
comment|'#   giturl: The location of conf.py on Git. Must be set manually.'
nl|'\n'
comment|'#   gitsha: The SHA checksum of the bug description. Extracted from git log.'
nl|'\n'
comment|'#   bug_tag: Tag for categorizing the bug. Must be set manually.'
nl|'\n'
comment|'#   bug_project: Launchpad project to file bugs against.'
nl|'\n'
comment|'# These variables are passed to the logabug code via html_context.'
nl|'\n'
DECL|variable|giturl
name|'giturl'
op|'='
string|"u'http://git.openstack.org/cgit/openstack/nova/tree/api-guide/source'"
newline|'\n'
DECL|variable|git_cmd
name|'git_cmd'
op|'='
op|'['
string|'"/usr/bin/git"'
op|','
string|'"rev-parse"'
op|','
string|'"HEAD"'
op|']'
newline|'\n'
DECL|variable|gitsha
name|'gitsha'
op|'='
name|'subprocess'
op|'.'
name|'Popen'
op|'('
nl|'\n'
name|'git_cmd'
op|','
name|'stdout'
op|'='
name|'subprocess'
op|'.'
name|'PIPE'
op|')'
op|'.'
name|'communicate'
op|'('
op|')'
op|'['
number|'0'
op|']'
newline|'\n'
nl|'\n'
nl|'\n'
comment|'# source tree'
nl|'\n'
DECL|variable|pwd
name|'pwd'
op|'='
name|'subprocess'
op|'.'
name|'Popen'
op|'('
nl|'\n'
string|'"pwd"'
op|','
name|'stdout'
op|'='
name|'subprocess'
op|'.'
name|'PIPE'
op|')'
op|'.'
name|'communicate'
op|'('
op|')'
op|'['
number|'0'
op|']'
op|'.'
name|'strip'
op|'('
string|"'\\n'"
op|')'
newline|'\n'
nl|'\n'
comment|'# html_context allows us to pass arbitrary values into the html template'
nl|'\n'
DECL|variable|html_context
name|'html_context'
op|'='
op|'{'
string|'"pwd"'
op|':'
name|'pwd'
op|','
nl|'\n'
string|'"gitsha"'
op|':'
name|'gitsha'
op|','
nl|'\n'
string|'"bug_tag"'
op|':'
name|'bug_tag'
op|','
nl|'\n'
string|'"giturl"'
op|':'
name|'giturl'
op|','
nl|'\n'
string|'"bug_project"'
op|':'
string|'"nova"'
op|'}'
newline|'\n'
nl|'\n'
comment|'# List of patterns, relative to source directory, that match files and'
nl|'\n'
comment|'# directories to ignore when looking for source files.'
nl|'\n'
DECL|variable|exclude_patterns
name|'exclude_patterns'
op|'='
op|'['
op|']'
newline|'\n'
nl|'\n'
comment|'# The reST default role (used for this markup: `text`) to use for all'
nl|'\n'
comment|'# documents.'
nl|'\n'
comment|'# default_role = None'
nl|'\n'
nl|'\n'
comment|"# If true, '()' will be appended to :func: etc. cross-reference text."
nl|'\n'
comment|'# add_function_parentheses = True'
nl|'\n'
nl|'\n'
comment|'# If true, the current module name will be prepended to all description'
nl|'\n'
comment|'# unit titles (such as .. function::).'
nl|'\n'
comment|'# add_module_names = True'
nl|'\n'
nl|'\n'
comment|'# If true, sectionauthor and moduleauthor directives will be shown in the'
nl|'\n'
comment|'# output. They are ignored by default.'
nl|'\n'
comment|'# show_authors = False'
nl|'\n'
nl|'\n'
comment|'# The name of the Pygments (syntax highlighting) style to use.'
nl|'\n'
DECL|variable|pygments_style
name|'pygments_style'
op|'='
string|"'sphinx'"
newline|'\n'
nl|'\n'
comment|'# A list of ignored prefixes for module index sorting.'
nl|'\n'
comment|'# modindex_common_prefix = []'
nl|'\n'
nl|'\n'
comment|'# If true, keep warnings as "system message" paragraphs in the built documents.'
nl|'\n'
comment|'# keep_warnings = False'
nl|'\n'
nl|'\n'
nl|'\n'
comment|'# -- Options for HTML output ----------------------------------------------'
nl|'\n'
nl|'\n'
comment|'# The theme to use for HTML and HTML Help pages.  See the documentation for'
nl|'\n'
comment|'# a list of builtin themes.'
nl|'\n'
DECL|variable|html_theme
name|'html_theme'
op|'='
string|"'openstackdocs'"
newline|'\n'
nl|'\n'
comment|'# Theme options are theme-specific and customize the look and feel of a theme'
nl|'\n'
comment|'# further.  For a list of options available for each theme, see the'
nl|'\n'
comment|'# documentation.'
nl|'\n'
comment|'# html_theme_options = {}'
nl|'\n'
nl|'\n'
comment|'# Add any paths that contain custom themes here, relative to this directory.'
nl|'\n'
DECL|variable|html_theme_path
name|'html_theme_path'
op|'='
op|'['
name|'openstackdocstheme'
op|'.'
name|'get_html_theme_path'
op|'('
op|')'
op|']'
newline|'\n'
nl|'\n'
comment|'# The name for this set of Sphinx documents.  If None, it defaults to'
nl|'\n'
comment|'# "<project> v<release> documentation".'
nl|'\n'
comment|'# html_title = None'
nl|'\n'
nl|'\n'
comment|'# A shorter title for the navigation bar.  Default is the same as html_title.'
nl|'\n'
comment|'# html_short_title = None'
nl|'\n'
nl|'\n'
comment|'# The name of an image file (relative to this directory) to place at the top'
nl|'\n'
comment|'# of the sidebar.'
nl|'\n'
comment|'# html_logo = None'
nl|'\n'
nl|'\n'
comment|'# The name of an image file (within the static path) to use as favicon of the'
nl|'\n'
comment|'# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32'
nl|'\n'
comment|'# pixels large.'
nl|'\n'
comment|'# html_favicon = None'
nl|'\n'
nl|'\n'
comment|'# Add any paths that contain custom static files (such as style sheets) here,'
nl|'\n'
comment|'# relative to this directory. They are copied after the builtin static files,'
nl|'\n'
comment|'# so a file named "default.css" will overwrite the builtin "default.css".'
nl|'\n'
DECL|variable|html_static_path
name|'html_static_path'
op|'='
op|'['
op|']'
newline|'\n'
nl|'\n'
comment|'# Add any extra paths that contain custom files (such as robots.txt or'
nl|'\n'
comment|'# .htaccess) here, relative to this directory. These files are copied'
nl|'\n'
comment|'# directly to the root of the documentation.'
nl|'\n'
comment|'# html_extra_path = []'
nl|'\n'
nl|'\n'
comment|"# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,"
nl|'\n'
comment|'# using the given strftime format.'
nl|'\n'
DECL|variable|html_last_updated_fmt
name|'html_last_updated_fmt'
op|'='
string|"'%Y-%m-%d %H:%M'"
newline|'\n'
nl|'\n'
comment|'# If true, SmartyPants will be used to convert quotes and dashes to'
nl|'\n'
comment|'# typographically correct entities.'
nl|'\n'
comment|'# html_use_smartypants = True'
nl|'\n'
nl|'\n'
comment|'# Custom sidebar templates, maps document names to template names.'
nl|'\n'
comment|'# html_sidebars = {}'
nl|'\n'
nl|'\n'
comment|'# Additional templates that should be rendered to pages, maps page names to'
nl|'\n'
comment|'# template names.'
nl|'\n'
comment|'# html_additional_pages = {}'
nl|'\n'
nl|'\n'
comment|'# If false, no module index is generated.'
nl|'\n'
comment|'# html_domain_indices = True'
nl|'\n'
nl|'\n'
comment|'# If false, no index is generated.'
nl|'\n'
DECL|variable|html_use_index
name|'html_use_index'
op|'='
name|'True'
newline|'\n'
nl|'\n'
comment|'# If true, the index is split into individual pages for each letter.'
nl|'\n'
comment|'# html_split_index = False'
nl|'\n'
nl|'\n'
comment|'# If true, links to the reST sources are added to the pages.'
nl|'\n'
comment|'# html_show_sourcelink = True'
nl|'\n'
nl|'\n'
comment|'# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.'
nl|'\n'
comment|'# html_show_sphinx = True'
nl|'\n'
nl|'\n'
comment|'# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.'
nl|'\n'
comment|'# html_show_copyright = True'
nl|'\n'
nl|'\n'
comment|'# If true, an OpenSearch description file will be output, and all pages will'
nl|'\n'
comment|'# contain a <link> tag referring to it.  The value of this option must be the'
nl|'\n'
comment|'# base URL from which the finished HTML is served.'
nl|'\n'
comment|"# html_use_opensearch = ''"
nl|'\n'
nl|'\n'
comment|'# This is the file name suffix for HTML files (e.g. ".xhtml").'
nl|'\n'
comment|'# html_file_suffix = None'
nl|'\n'
nl|'\n'
comment|'# Output file base name for HTML help builder.'
nl|'\n'
DECL|variable|htmlhelp_basename
name|'htmlhelp_basename'
op|'='
string|"'compute-api-guide'"
newline|'\n'
nl|'\n'
nl|'\n'
comment|'# -- Options for LaTeX output ---------------------------------------------'
nl|'\n'
nl|'\n'
DECL|variable|latex_elements
name|'latex_elements'
op|'='
op|'{'
nl|'\n'
comment|"# The paper size ('letterpaper' or 'a4paper')."
nl|'\n'
comment|"# 'papersize': 'letterpaper',"
nl|'\n'
nl|'\n'
comment|"# The font size ('10pt', '11pt' or '12pt')."
nl|'\n'
comment|"# 'pointsize': '10pt',"
nl|'\n'
nl|'\n'
comment|'# Additional stuff for the LaTeX preamble.'
nl|'\n'
comment|"# 'preamble': '',"
nl|'\n'
op|'}'
newline|'\n'
nl|'\n'
comment|'# Grouping the document tree into LaTeX files. List of tuples'
nl|'\n'
comment|'# (source start file, target name, title,'
nl|'\n'
comment|'#  author, documentclass [howto, manual, or own class]).'
nl|'\n'
DECL|variable|latex_documents
name|'latex_documents'
op|'='
op|'['
nl|'\n'
op|'('
string|"'index'"
op|','
string|"'ComputeAPI.tex'"
op|','
string|"u'Compute API Documentation'"
op|','
nl|'\n'
string|"u'OpenStack contributors'"
op|','
string|"'manual'"
op|')'
op|','
nl|'\n'
op|']'
newline|'\n'
nl|'\n'
comment|'# The name of an image file (relative to this directory) to place at the top of'
nl|'\n'
comment|'# the title page.'
nl|'\n'
comment|'# latex_logo = None'
nl|'\n'
nl|'\n'
comment|'# For "manual" documents, if this is true, then toplevel headings are parts,'
nl|'\n'
comment|'# not chapters.'
nl|'\n'
comment|'# latex_use_parts = False'
nl|'\n'
nl|'\n'
comment|'# If true, show page references after internal links.'
nl|'\n'
comment|'# latex_show_pagerefs = False'
nl|'\n'
nl|'\n'
comment|'# If true, show URL addresses after external links.'
nl|'\n'
comment|'# latex_show_urls = False'
nl|'\n'
nl|'\n'
comment|'# Documents to append as an appendix to all manuals.'
nl|'\n'
comment|'# latex_appendices = []'
nl|'\n'
nl|'\n'
comment|'# If false, no module index is generated.'
nl|'\n'
comment|'# latex_domain_indices = True'
nl|'\n'
nl|'\n'
nl|'\n'
comment|'# -- Options for manual page output ---------------------------------------'
nl|'\n'
nl|'\n'
comment|'# One entry per manual page. List of tuples'
nl|'\n'
comment|'# (source start file, name, description, authors, manual section).'
nl|'\n'
DECL|variable|man_pages
name|'man_pages'
op|'='
op|'['
nl|'\n'
op|'('
string|"'index'"
op|','
string|"'computeapi'"
op|','
string|"u'Compute API Documentation'"
op|','
nl|'\n'
op|'['
string|"u'OpenStack contributors'"
op|']'
op|','
number|'1'
op|')'
nl|'\n'
op|']'
newline|'\n'
nl|'\n'
comment|'# If true, show URL addresses after external links.'
nl|'\n'
comment|'# man_show_urls = False'
nl|'\n'
nl|'\n'
nl|'\n'
comment|'# -- Options for Texinfo output -------------------------------------------'
nl|'\n'
nl|'\n'
comment|'# Grouping the document tree into Texinfo files. List of tuples'
nl|'\n'
comment|'# (source start file, target name, title, author,'
nl|'\n'
comment|'#  dir menu entry, description, category)'
nl|'\n'
DECL|variable|texinfo_documents
name|'texinfo_documents'
op|'='
op|'['
nl|'\n'
op|'('
string|"'index'"
op|','
string|"'ComputeAPIGuide'"
op|','
string|"u'Compute API Guide'"
op|','
nl|'\n'
string|"u'OpenStack contributors'"
op|','
string|"'APIGuide'"
op|','
nl|'\n'
string|"'This guide teaches OpenStack Compute service users concepts about '"
nl|'\n'
string|"'managing resources in an OpenStack cloud with the Compute API.'"
op|','
nl|'\n'
string|"'Miscellaneous'"
op|')'
op|','
nl|'\n'
op|']'
newline|'\n'
nl|'\n'
comment|'# Documents to append as an appendix to all manuals.'
nl|'\n'
comment|'# texinfo_appendices = []'
nl|'\n'
nl|'\n'
comment|'# If false, no module index is generated.'
nl|'\n'
comment|'# texinfo_domain_indices = True'
nl|'\n'
nl|'\n'
comment|"# How to display URL addresses: 'footnote', 'no', or 'inline'."
nl|'\n'
comment|"# texinfo_show_urls = 'footnote'"
nl|'\n'
nl|'\n'
comment|'# If true, do not generate a @detailmenu in the "Top" node\'s menu.'
nl|'\n'
comment|'# texinfo_no_detailmenu = False'
nl|'\n'
nl|'\n'
comment|'# -- Options for Internationalization output ------------------------------'
nl|'\n'
DECL|variable|locale_dirs
name|'locale_dirs'
op|'='
op|'['
string|"'locale/'"
op|']'
newline|'\n'
nl|'\n'
comment|'# -- Options for PDF output --------------------------------------------------'
nl|'\n'
nl|'\n'
DECL|variable|pdf_documents
name|'pdf_documents'
op|'='
op|'['
nl|'\n'
op|'('
string|"'index'"
op|','
string|"u'ComputeAPIGuide'"
op|','
string|"u'Compute API Guide'"
op|','
string|"u'OpenStack '"
nl|'\n'
string|"'contributors'"
op|')'
nl|'\n'
op|']'
newline|'\n'
endmarker|''
end_unit
