@ -1,6 +1,3 @@
# -*- coding: utf-8 -*-
# Copyright (c) 2010 OpenStack Foundation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
@ -14,237 +11,65 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Keystone documentation build configuration file, created by
# sphinx-quickstart on Tue May 18 13:50:15 2010.
#
# This file is execfile()'d with the current directory set to it's 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 os
import sys
# 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.
BASE_DIR = os . path . dirname ( os . path . abspath ( __file__ ) )
NEUTRON_DIR = os . path . abspath ( os . path . join ( BASE_DIR , " .. " , " .. " ) )
sys . path . insert ( 0 , NEUTRON_DIR )
# -- General configuration ---------------------------------------------------
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 ' ,
' sphinx.ext.coverage ' ,
' sphinx.ext.ifconfig ' ,
' sphinx.ext.intersphinx ' ,
' sphinx.ext.pngmath ' ,
' sphinx.ext.graphviz ' ,
' sphinx.ext.todo ' ,
' oslosphinx ' ]
todo_include_todos = True
extensions = [
' sphinx.ext.autodoc ' ,
#'sphinx.ext.intersphinx',
' stevedore.sphinxext ' ,
' oslosphinx '
]
# Add any paths that contain templates here, relative to this directory.
templates_path = [ ]
if os . getenv ( ' HUDSON_PUBLISH_DOCS ' ) :
templates_path = [ ' _ga ' , ' _templates ' ]
else :
templates_path = [ ' _templates ' ]
# 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
# 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 ' Neutron '
copyright = u ' 2011-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.
#
# Version info
from neutron . version import version_info as neutron_version
release = neutron_version . release_string ( )
# The short X.Y version.
version = neutron_version . 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'
# List of documents that shouldn't be included in the build.
# unused_docs = []
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = [ ]
# The reST default role (for this markup: `text`) to use for all documents.
#default_role = None
project = u ' tacker '
copyright = u ' 2013, OpenStack Foundation '
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses =
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
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = True
add_module_names = True
# 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 = [ ' neutron. ' ]
# -- 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/neutron-server ' , ' neutron-server ' , u ' Neutron Server ' ,
[ u ' OpenStack ' ] , 1 )
]
# -- Options for HTML output -------------------------------------------------
# -- 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 = ['_theme']
# 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: ' %a d, commit % h ' --date=local -n1 "
html_last_updated_fmt = os . popen ( git_cmd ) . read ( )
# 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 = ''
# html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = ' neutrondoc '
# -- 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'
htmlhelp_basename = ' %s doc ' % project
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author,
# documentclass [howto/manual]).
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
( ' index ' , ' Neutron.tex ' , u ' Neutron Documentation ' ,
u ' Neutron development team ' , ' manual ' ) ,
( ' index ' ,
' %s .tex ' % project ,
u ' %s Documentation ' % project ,
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
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = { ' python ' : ( ' http://docs.python.org/ ' , None ) ,
' nova ' : ( ' http://nova.openstack.org ' , None ) ,
' swift ' : ( ' http://swift.openstack.org ' , None ) ,
' glance ' : ( ' http://glance.openstack.org ' , None ) ,
' horizon ' : ( ' http://horizon.openstack.org ' , None ) ,
' keystone ' : ( ' http://keystone.openstack.org ' , None ) ,
}
#intersphinx_mapping = {'http://docs.python.org/': None}
Sridhar Ramaswamy
7 years ago