428f0367b7
Add sequence diagrams generated by sphinxcontrib-seqdiag along with the raw text that generated then, so that it can be updated easily later. The diagrams were created originally by Devananda van der Veen, and used in OpenStack Summit YVR. Ref) * https://www.openstack.org/summit/vancouver-2015/summit-videos /presentation/isn-and-039t-it-ironic-the-bare-metal-cloud * http://devananda.github.io/talks/isnt-it-ironic.html Change-Id: I47ff02c6cb4764c1740d0924668714ed205b3d9b
88 lines
2.6 KiB
Python
88 lines
2.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
|
|
# -- 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',
|
|
'sphinx.ext.viewcode',
|
|
'sphinxcontrib.httpdomain',
|
|
'sphinxcontrib.pecanwsme.rest',
|
|
'sphinxcontrib.seqdiag',
|
|
'wsmeext.sphinxext',
|
|
'oslosphinx',
|
|
]
|
|
|
|
wsme_protocols = ['restjson']
|
|
|
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
|
# text edit cycles.
|
|
# execute "export SPHINX_DEBUG=1" in your terminal to disable
|
|
|
|
# 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'Ironic'
|
|
copyright = u'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 short X.Y version.
|
|
from ironic import version as ironic_version
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = ironic_version.version_info.release_string()
|
|
# The short X.Y version.
|
|
version = ironic_version.version_info.version_string()
|
|
|
|
# A list of ignored prefixes for module index sorting.
|
|
modindex_common_prefix = ['ironic.']
|
|
|
|
# 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 = True
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# -- 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'
|
|
#html_static_path = ['_static']
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = '%sdoc' % project
|
|
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, documentclass
|
|
# [howto/manual]).
|
|
latex_documents = [
|
|
(
|
|
'index',
|
|
'%s.tex' % project,
|
|
u'%s Documentation' % project,
|
|
u'OpenStack Foundation',
|
|
'manual'
|
|
),
|
|
]
|
|
|
|
# -- Options for seqdiag ------------------------------------------------------
|
|
|
|
seqdiag_html_image_format = "SVG"
|