summaryrefslogtreecommitdiffstats
path: root/doc/source
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2012-08-20 20:24:15 +0000
committerGerrit Code Review <review@openstack.org>2012-08-20 20:24:15 +0000
commitacb1f3fe327cb37606e274e1afaab5020628b73c (patch)
treea0cd29407626b9b07864d163051ec2ad6f963eba /doc/source
parent8378f316454fe74d171a09ce9af91f1da6692c21 (diff)
parent9424514e6f8864f1ee04348b3c5cd32112fe6438 (diff)
downloadnova-acb1f3fe327cb37606e274e1afaab5020628b73c.tar.gz
nova-acb1f3fe327cb37606e274e1afaab5020628b73c.tar.xz
nova-acb1f3fe327cb37606e274e1afaab5020628b73c.zip
Merge "Fix PEP8 issues"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/conf.py48
1 files changed, 28 insertions, 20 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 78feba48e..1f2bb9424 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -3,7 +3,8 @@
# nova documentation build configuration file, created by
# sphinx-quickstart on Sat May 1 15:17:47 2010.
#
-# 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,7 +12,8 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, os
+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
@@ -20,23 +22,30 @@ sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('./'))
-# -- General configuration -----------------------------------------------------
+# -- 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.
+# 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.intersphinx', 'ext.nova_todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig','sphinx.ext.graphviz']
+extensions = ['sphinx.ext.autodoc',
+ 'sphinx.ext.intersphinx',
+ 'ext.nova_todo',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.pngmath',
+ 'sphinx.ext.ifconfig',
+ 'sphinx.ext.graphviz']
todo_include_todos = True
# Add any paths that contain templates here, relative to this directory.
-# Changing the path so that the Hudson build output contains GA code and the source
-# docs do not contain the code so local, offline sphinx builds are "clean."
+# Changing the path so that the Hudson build output contains GA code
+# and the source docs do not contain the code so local, offline sphinx builds
+# are "clean."
templates_path = []
if os.getenv('HUDSON_PUBLISH_DOCS'):
- templates_path = ['_ga', '_templates']
+ templates_path = ['_ga', '_templates']
else:
- templates_path = ['_templates']
+ templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@@ -83,7 +92,8 @@ unused_docs = [
# for source files.
exclude_trees = []
-# The reST default role (used for this markup: `text`) to use for all documents.
+# 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.
@@ -103,7 +113,7 @@ pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['nova.']
-# -- Options for man page output -----------------------------------------------
+# -- Options for man page output ----------------------------------------------
# Grouping the document tree for man pages.
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
@@ -113,7 +123,7 @@ man_pages = [
[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'.
@@ -190,7 +200,7 @@ html_last_updated_fmt = os.popen(git_cmd).read()
htmlhelp_basename = 'novadoc'
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output -------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
@@ -199,11 +209,10 @@ htmlhelp_basename = 'novadoc'
#latex_font_size = '10pt'
# 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'Anso Labs, LLC', 'manual'),
-]
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [('index', 'Nova.tex', u'Nova Documentation',
+ u'Anso Labs, LLC', 'manual'), ]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
@@ -226,4 +235,3 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'python': ('http://docs.python.org/', None),
'swift': ('http://swift.openstack.org', None)}
-