From 3a296a458c4e2f9465ddc0330d03c3e7ec0e3c50 Mon Sep 17 00:00:00 2001 From: Chmouel Boudjnah Date: Tue, 20 Mar 2012 10:09:25 +0000 Subject: Spring cleaning, fix PEP8 violations. Change-Id: Ide832cd64c9b285213e23901eaf81946d504e726 --- doc/source/conf.py | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) (limited to 'doc') diff --git a/doc/source/conf.py b/doc/source/conf.py index db40a2c7..ab5d5914 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -3,7 +3,8 @@ # keystone documentation build configuration file, created by # sphinx-quickstart on Mon Jan 9 12:02:59 2012. # -# 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. @@ -19,14 +20,17 @@ import os # documentation root, use os.path.abspath to make it absolute, like shown here. 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' -# 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', 'sphinx.ext.todo', 'sphinx.ext.coverage'] +# 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', +# 'sphinx.ext.todo', 'sphinx.ext.coverage'] extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', # 'sphinx.ect.intersphinx', @@ -77,7 +81,8 @@ release = '2012.1-dev' # directories to ignore when looking for source files. exclude_patterns = [] -# 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. @@ -110,7 +115,7 @@ 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. @@ -193,7 +198,7 @@ html_last_updated_fmt = os.popen(git_cmd).read() htmlhelp_basename = 'keystonedoc' -# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output latex_elements = { # The paper size ('letterpaper' or 'a4paper'). @@ -206,8 +211,9 @@ latex_elements = { #'preamble': '', } -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). +# Grouping the document tree into LaTeX files. List of tuples (source +# start file, target name, title, author, documentclass +# [howto/manual]). latex_documents = [ ('index', 'keystone.tex', u'Keystone Documentation', u'OpenStack', 'manual'), @@ -234,20 +240,19 @@ latex_documents = [ #latex_domain_indices = True -# -- Options for manual page output -------------------------------------------- +# -- Options for manual page output # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'keystone', u'Keystone Documentation', - [u'OpenStack'], 1) -] + [u'OpenStack'], 1)] # If true, show URL addresses after external links. #man_show_urls = False -# -- 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, -- cgit