@ -3,7 +3,8 @@
# Tempest documentation build configuration file, created by
# sphinx-quickstart on Tue May 21 17:43:32 2013.
#
# This file is execfile()d with the current directory set to its containing dir.
# 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.
@ -11,14 +12,18 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import subprocess
import os
import sys
from pydotplus import graphviz
import sadisplay
from sphinx import apidoc
import octavia . db . models as models
sys . path . insert ( 0 , os . path . abspath ( ' ../.. ' ) )
sys . path . insert ( 0 , os . path . abspath ( ' . ' ) )
from tools import create_flow_docs
# Generate our flow diagrams
@ -38,28 +43,29 @@ graph.write('contributor/devref/erd.svg', format='svg')
# 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 ( ' ../../octavia ' ) )
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ---------------------------------------------------- -
# -- General configuration ----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# 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.todo ' ,
' sphinx.ext.viewcode ' ,
' sphinxcontrib.blockdiag ' ,
' sphinxcontrib.actdiag ' ,
' sphinxcontrib.seqdiag ' ,
' sphinxcontrib.nwdiag ' ,
' sphinx.ext.graphviz ' ,
' openstackdocstheme ' ,
' oslo_config.sphinxext ' ,
' oslo_policy.sphinxpolicygen '
]
extensions = [
' sphinx.ext.autodoc ' ,
' sphinx.ext.todo ' ,
' sphinx.ext.viewcode ' ,
' sphinxcontrib.blockdiag ' ,
' sphinxcontrib.actdiag ' ,
' sphinxcontrib.seqdiag ' ,
' sphinxcontrib.nwdiag ' ,
' sphinx.ext.graphviz ' ,
' openstackdocstheme ' ,
' oslo_config.sphinxext ' ,
' oslo_policy.sphinxpolicygen '
]
todo_include_todos = True
@ -70,7 +76,7 @@ templates_path = ['_templates']
source_suffix = ' .rst '
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = ' index '
@ -81,25 +87,28 @@ copyright = u'2014, OpenStack Octavia Team'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = [ ' _build ' ,
' contributor/specs/skeleton.rst ' ,
' contributor/specs/template.rst ' ]
exclude_patterns = [
' _build ' ,
' contributor/specs/skeleton.rst ' ,
' contributor/specs/template.rst '
]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# 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
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
@ -118,7 +127,7 @@ modindex_common_prefix = ['octavia.']
# -- Options for man page output ----------------------------------------------
man_pages = [ ]
# -- Options for HTML output -------------------------------------------------- -
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
@ -127,26 +136,26 @@ html_theme = 'openstackdocs'
# 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 = {}
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# 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
# 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
# html_favicon = None
html_static_path = [ ' _static ' ]
@ -156,14 +165,14 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# html_additional_pages = {}
# If false, no module index is generated.
html_domain_indices = True
@ -172,91 +181,99 @@ html_domain_indices = True
html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# html_split_index = False
# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True
# html_show_copyright = 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 = ''
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = ' Octavia-Specsdoc '
# -- Options for LaTeX output ------------------------------------------------- -
# -- Options for LaTeX output -------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
( ' index ' , ' Octavia-specs.tex ' , u ' Octavia Specs ' ,
u ' OpenStack Octavia Team ' , ' manual ' ) ,
]
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [ (
' index ' ,
' Octavia-specs.tex ' ,
u ' Octavia Specs ' ,
u ' OpenStack Octavia Team ' ,
' manual '
) ]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# latex_use_parts = False
# If true, show page references after internal links.
# latex_show_pagerefs = False
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
# latex_show_urls = False
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# latex_appendices = []
# If false, no module index is generated.
# latex_domain_indices = True
# latex_domain_indices = True
# -- Options for Texinfo output ----------------------------------------------- -
# -- Options for Texinfo output -----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
( ' index ' , ' Octavia-specs ' , u ' Octavia Design Specs ' ,
u ' OpenStack Octavia Team ' , ' octavia-specs ' , ' Design specifications for the Octavia project. ' ,
' Miscellaneous ' ) ,
]
texinfo_documents = [ (
' index ' ,
' Octavia-specs ' ,
u ' Octavia Design Specs ' ,
u ' OpenStack Octavia Team ' ,
' octavia-specs ' ,
' Design specifications for the Octavia project. ' ,
' Miscellaneous '
) ]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# texinfo_appendices = []
# If false, no module index is generated.
# texinfo_domain_indices = True
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'
# texinfo_show_urls = 'footnote'
# -- Options for Epub output -------------------------------------------------- -
# -- Options for Epub output --------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u ' Octavia Specs '
@ -266,37 +283,37 @@ epub_copyright = u'2014, OpenStack Octavia Team'
# The language of the text. It defaults to the language option
# or en if the language is not set.
# epub_language = ''
# epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
# epub_scheme = ''
# epub_scheme = ''
# The unique identifier of the text. This can be an ISBN number
# or the project homepage.
# epub_identifier = ''
# epub_identifier = ''
# A unique identification for the text.
# epub_uid = ''
# epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
# epub_cover = ()
# epub_cover = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
# epub_pre_files = []
# epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
# epub_post_files = []
# epub_post_files = []
# A list of files that should not be packed into the epub file.
# epub_exclude_files = []
# epub_exclude_files = []
# The depth of the table of contents in toc.ncx.
# epub_tocdepth = 3
# epub_tocdepth = 3
# Allow duplicate toc entries.
# epub_tocdup = True
# epub_tocdup = True
# RBAC sample policy file generation
policy_generator_config_file = ' ../../etc/policy/octavia-policy-generator.conf '
@ -304,8 +321,31 @@ sample_policy_basename = 'configuration/_static/octavia'
# openstackdocstheme options
html_theme_options = {
" display_toc " : False
' display_toc ' : False
}
repository_name = ' openstack/octavia '
bug_project = ' octavia '
bug_tag = ' docs '
# TODO(mordred) We should extract this into a sphinx plugin
def run_apidoc ( _ ) :
cur_dir = os . path . abspath ( os . path . dirname ( __file__ ) )
out_dir = os . path . join ( cur_dir , ' contributor ' , ' modules ' )
module = os . path . join ( cur_dir , ' .. ' , ' .. ' , ' octavia ' )
# Keep the order of arguments same as the sphinx-apidoc help, otherwise it
# would cause unexpected errors:
# sphinx-apidoc [options] -o <output_path> <module_path>
# [exclude_pattern, ...]
apidoc . main ( [
' --force ' ,
' -o ' ,
out_dir ,
module ,
' octavia/tests ' ,
' octavia/db/migration '
] )
def setup ( app ) :
app . connect ( ' builder-inited ' , run_apidoc )
Monty Taylor
5 years ago
committed by