bf7203ac89
There's a lot of duplication here. Given that 'conf.py' is Python, we can simplify this greatly and focus on the real content differences. The description text is the same for all options, but this isn't centralized as it shouldn't be the same (this field should contain a description of each individual tool). Change-Id: I1a2a55ac7f041387597ef93be62411fe1673f8c1
143 lines
5.1 KiB
Python
143 lines
5.1 KiB
Python
# nova documentation build configuration file
|
|
#
|
|
# Refer to the Sphinx documentation for advice on configuring this file:
|
|
#
|
|
# http://www.sphinx-doc.org/en/stable/config.html
|
|
|
|
import subprocess
|
|
import sys
|
|
import os
|
|
import warnings
|
|
|
|
from nova.version import version_info
|
|
|
|
# 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',
|
|
'oslo_policy.sphinxpolicygen',
|
|
'ext.versioned_notifications',
|
|
'ext.feature_matrix',
|
|
]
|
|
|
|
config_generator_config_file = '../../etc/nova/nova-config-generator.conf'
|
|
sample_config_basename = '_static/nova'
|
|
|
|
policy_generator_config_file = '../../etc/nova/nova-policy-generator.conf'
|
|
sample_policy_basename = '_static/nova'
|
|
|
|
todo_include_todos = True
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# 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.
|
|
#
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = version_info.release_string()
|
|
# The short X.Y version.
|
|
version = version_info.version_string()
|
|
|
|
# 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.*',
|
|
]
|
|
|
|
# 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 = [
|
|
('nova-api-metadata', u'Cloud controller fabric'),
|
|
('nova-api-os-compute', u'Cloud controller fabric'),
|
|
('nova-api', u'Cloud controller fabric'),
|
|
('nova-cells', u'Cloud controller fabric'),
|
|
('nova-compute', u'Cloud controller fabric'),
|
|
('nova-console', u'Cloud controller fabric'),
|
|
('nova-consoleauth', u'Cloud controller fabric'),
|
|
('nova-dhcpbridge', u'Cloud controller fabric'),
|
|
('nova-idmapshift', u'Cloud controller fabric'),
|
|
('nova-manage', u'Cloud controller fabric'),
|
|
('nova-network', u'Cloud controller fabric'),
|
|
('nova-novncproxy', u'Cloud controller fabric'),
|
|
('nova-spicehtml5proxy', u'Cloud controller fabric'),
|
|
('nova-serialproxy', u'Cloud controller fabric'),
|
|
('nova-rootwrap', u'Cloud controller fabric'),
|
|
('nova-scheduler', u'Cloud controller fabric'),
|
|
('nova-xvpvncproxy', u'Cloud controller fabric'),
|
|
('nova-conductor', u'Cloud controller fabric'),
|
|
]
|
|
|
|
man_pages = [
|
|
('man/%s' % name, name, description, [u'OpenStack'], 1)
|
|
for name, description in _man_pages]
|
|
|
|
# -- Options for HTML output --------------------------------------------------
|
|
|
|
# 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.
|
|
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
|
|
"-n1"]
|
|
try:
|
|
html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
|
|
except Exception:
|
|
warnings.warn('Cannot get last updated time from git repository. '
|
|
'Not setting "html_last_updated_fmt".')
|
|
|
|
# -- Options for LaTeX output -------------------------------------------------
|
|
|
|
# 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'),
|
|
]
|