83 lines
2.6 KiB
Python
83 lines
2.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
import datetime
|
|
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('.'))
|
|
|
|
# -- 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 = ['redirect',
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.viewcode',
|
|
'oslosphinx',
|
|
'yasfb',
|
|
'sphinxcontrib.seqdiag',
|
|
]
|
|
|
|
todo_include_todos = True
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = u'Nova Specs'
|
|
copyright = u'%s, OpenStack Nova Team' % datetime.date.today().year
|
|
|
|
# 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-specs.']
|
|
|
|
# -- Options for HTML output ---------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
html_theme = 'nature'
|
|
|
|
# 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"
|
|
html_last_updated_fmt = os.popen(git_cmd).read()
|
|
|
|
# If false, no module index is generated.
|
|
html_domain_indices = False
|
|
|
|
# If false, no index is generated.
|
|
html_use_index = False
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'Nova-Specsdoc'
|
|
|
|
|
|
# -- yasfb configuration -------------------------------------------------------
|
|
|
|
feed_base_url = 'http://specs.openstack.org/openstack/nova-specs'
|
|
feed_author = 'OpenStack Nova Team'
|
|
|
|
# -- seqdiag configuration -----------------------------------------------------
|
|
seqdiag_html_image_format = 'SVG'
|
|
seqdiag_antialias = True
|