05adc8d006
This commit adds a new sphinx extension that inspects the nova code and adds information about the existing versioned notifications to the nofitications devref. This way the devref is automatically kept up to date with relevant information. Partially-Implements: bp versioned-notification-api Change-Id: If65d5d81e26cb2b4a9f57a8c7d37d3de310ebe00
267 lines
9.1 KiB
Python
267 lines
9.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# nova documentation build configuration file, created by
|
|
# sphinx-quickstart on Sat May 1 15:17:47 2010.
|
|
#
|
|
# This file is execfile()d with the current directory set to
|
|
# its containing dir.
|
|
#
|
|
# Note that not all possible configuration values are present in this
|
|
# autogenerated file.
|
|
#
|
|
# All configuration values have a default; values that are commented out
|
|
# serve to show the default.
|
|
|
|
import subprocess
|
|
import sys
|
|
import os
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
sys.path.insert(0, os.path.abspath('../../'))
|
|
sys.path.insert(0, os.path.abspath('../'))
|
|
sys.path.insert(0, os.path.abspath('./'))
|
|
|
|
# -- General configuration ----------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
|
|
extensions = ['sphinx.ext.autodoc',
|
|
'ext.nova_todo',
|
|
'sphinx.ext.coverage',
|
|
'sphinx.ext.graphviz',
|
|
'oslosphinx',
|
|
"ext.support_matrix",
|
|
'oslo_config.sphinxconfiggen',
|
|
'ext.versioned_notifications'
|
|
]
|
|
|
|
config_generator_config_file = '../../etc/nova/nova-config-generator.conf'
|
|
sample_config_basename = '_static/nova'
|
|
|
|
todo_include_todos = True
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The encoding of source files.
|
|
#source_encoding = 'utf-8'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = u'nova'
|
|
copyright = u'2010-present, OpenStack Foundation'
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
#
|
|
from nova.version import version_info
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = version_info.release_string()
|
|
# The short X.Y version.
|
|
version = version_info.version_string()
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#language = None
|
|
|
|
# There are two options for replacing |today|: either, you set today to some
|
|
# non-false value, then it is used:
|
|
#today = ''
|
|
# Else, today_fmt is used as the format for a strftime call.
|
|
#today_fmt = '%B %d, %Y'
|
|
|
|
# A list of glob-style patterns that should be excluded when looking for
|
|
# source files. They are matched against the source file names relative to the
|
|
# source directory, using slashes as directory separators on all platforms.
|
|
exclude_patterns = [
|
|
'api/nova.wsgi.nova-*',
|
|
'api/nova.tests.*',
|
|
]
|
|
|
|
# The reST default role (used for this markup: `text`) to use
|
|
# for all documents.
|
|
#default_role = None
|
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
#add_function_parentheses = True
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
# unit titles (such as .. function::).
|
|
add_module_names = False
|
|
|
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
|
# output. They are ignored by default.
|
|
show_authors = False
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# A list of ignored prefixes for module index sorting.
|
|
modindex_common_prefix = ['nova.']
|
|
|
|
# -- Options for man page output ----------------------------------------------
|
|
|
|
# Grouping the document tree for man pages.
|
|
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
|
|
|
|
man_pages = [
|
|
('man/nova-all', 'nova-all', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-api-metadata', 'nova-api-metadata', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-api-os-compute', 'nova-api-os-compute',
|
|
u'Cloud controller fabric', [u'OpenStack'], 1),
|
|
('man/nova-api', 'nova-api', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-cells', 'nova-cells', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-cert', 'nova-cert', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-compute', 'nova-compute', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-console', 'nova-console', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-consoleauth', 'nova-consoleauth', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-dhcpbridge', 'nova-dhcpbridge', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-idmapshift', 'nova-idmapshift', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-manage', 'nova-manage', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-network', 'nova-network', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-novncproxy', 'nova-novncproxy', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-spicehtml5proxy', 'nova-spicehtml5proxy', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-serialproxy', 'nova-serialproxy', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-rootwrap', 'nova-rootwrap', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-scheduler', 'nova-scheduler', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-xvpvncproxy', 'nova-xvpvncproxy', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
('man/nova-conductor', 'nova-conductor', u'Cloud controller fabric',
|
|
[u'OpenStack'], 1),
|
|
]
|
|
|
|
# -- Options for HTML output --------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
|
# Sphinx are currently 'default' and 'sphinxdoc'.
|
|
# html_theme_path = ["."]
|
|
# html_theme = '_theme'
|
|
|
|
# Theme options are theme-specific and customize the look and feel of a theme
|
|
# further. For a list of options available for each theme, see the
|
|
# documentation.
|
|
#html_theme_options = {}
|
|
|
|
# Add any paths that contain custom themes here, relative to this directory.
|
|
#html_theme_path = []
|
|
|
|
# The name for this set of Sphinx documents. If None, it defaults to
|
|
# "<project> v<release> documentation".
|
|
#html_title = None
|
|
|
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
|
#html_short_title = None
|
|
|
|
# The name of an image file (relative to this directory) to place at the top
|
|
# of the sidebar.
|
|
#html_logo = None
|
|
|
|
# The name of an image file (within the static path) to use as favicon of the
|
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
# pixels large.
|
|
#html_favicon = None
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ['_static']
|
|
|
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
# using the given strftime format.
|
|
#html_last_updated_fmt = '%b %d, %Y'
|
|
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
|
|
"-n1"]
|
|
html_last_updated_fmt = subprocess.Popen(
|
|
git_cmd, stdout=subprocess.PIPE).communicate()[0]
|
|
|
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
# typographically correct entities.
|
|
#html_use_smartypants = True
|
|
|
|
# Custom sidebar templates, maps document names to template names.
|
|
#html_sidebars = {}
|
|
|
|
# Additional templates that should be rendered to pages, maps page names to
|
|
# template names.
|
|
#html_additional_pages = {}
|
|
|
|
# If false, no module index is generated.
|
|
#html_use_modindex = True
|
|
|
|
# If false, no index is generated.
|
|
#html_use_index = True
|
|
|
|
# If true, the index is split into individual pages for each letter.
|
|
#html_split_index = False
|
|
|
|
# If true, links to the reST sources are added to the pages.
|
|
#html_show_sourcelink = True
|
|
|
|
# If true, an OpenSearch description file will be output, and all pages will
|
|
# contain a <link> tag referring to it. The value of this option must be the
|
|
# base URL from which the finished HTML is served.
|
|
#html_use_opensearch = ''
|
|
|
|
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
|
|
#html_file_suffix = ''
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'novadoc'
|
|
|
|
|
|
# -- Options for LaTeX output -------------------------------------------------
|
|
|
|
# The paper size ('letter' or 'a4').
|
|
#latex_paper_size = 'letter'
|
|
|
|
# The font size ('10pt', '11pt' or '12pt').
|
|
#latex_font_size = '10pt'
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, documentclass
|
|
# [howto/manual]).
|
|
latex_documents = [
|
|
('index', 'Nova.tex', u'Nova Documentation',
|
|
u'OpenStack Foundation', 'manual'),
|
|
]
|
|
|
|
# The name of an image file (relative to this directory) to place at the top of
|
|
# the title page.
|
|
#latex_logo = None
|
|
|
|
# For "manual" documents, if this is true, then toplevel headings are parts,
|
|
# not chapters.
|
|
#latex_use_parts = False
|
|
|
|
# Additional stuff for the LaTeX preamble.
|
|
#latex_preamble = ''
|
|
|
|
# Documents to append as an appendix to all manuals.
|
|
#latex_appendices = []
|
|
|
|
# If false, no module index is generated.
|
|
#latex_use_modindex = True
|