Skip to content
This repository was archived by the owner on May 28, 2022. It is now read-only.

Commit 63a1aeb

Browse files
habidideler
authored andcommitted
Fix PEP8 coding style violations in Sphinx config
Fix minor PEP8 violations in docs/source/conf.py. As part of http://24pullrequests.com
1 parent 872c68c commit 63a1aeb

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/source/conf.py

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
# Freeseer documentation build configuration file, created by
44
# sphinx-quickstart on Sun Sep 4 18:21:52 2011.
55
#
6-
# This file is execfile()d with the current directory set to its containing dir.
7-
#
86
# Note that not all possible configuration values are present in this
97
# autogenerated file.
108
#
@@ -18,19 +16,19 @@
1816
# add these directories to sys.path here.
1917
sys.path.append('../src') # Temporarily add freeseer/src to $PATH.
2018

21-
# -- General configuration -----------------------------------------------------
19+
# -- General configuration ----------------------------------------------------
2220

2321
# If your documentation needs a minimal Sphinx version, state it here.
2422
#needs_sphinx = '1.0'
2523

26-
# Add any Sphinx extension module names here, as strings. They can be extensions
27-
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.viewcode',
29-
'sphinx.ext.todo']
24+
# Add any Sphinx extension module names here, as strings. They can be
25+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
26+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
27+
'sphinx.ext.viewcode', 'sphinx.ext.todo']
3028

3129
# If True, the todo and todolist directives will produce output.
3230
# http://sphinx.pocoo.org/ext/todo.html#module-sphinx.ext.todo
33-
todo_include_todos=True
31+
todo_include_todos = True
3432

3533
# Add any paths that contain templates here, relative to this directory.
3634
templates_path = ['_templates']
@@ -71,7 +69,7 @@
7169
# directories to ignore when looking for source files.
7270
exclude_patterns = ['contribute/packaging.rst']
7371

74-
# The reST default role (used for this markup: `text`) to use for all documents.
72+
# The reST default role (for text `like this`) to use for all documents.
7573
#default_role = None
7674

7775
# If true, '()' will be appended to :func: etc. cross-reference text.
@@ -92,7 +90,7 @@
9290
#modindex_common_prefix = []
9391

9492

95-
# -- Options for HTML output ---------------------------------------------------
93+
# -- Options for HTML output --------------------------------------------------
9694

9795
# The theme to use for HTML and HTML Help pages. See the documentation for
9896
# a list of builtin themes.
@@ -172,20 +170,22 @@
172170
htmlhelp_basename = 'Freeseerdoc'
173171

174172

175-
# -- Options for LaTeX output --------------------------------------------------
173+
# -- Options for LaTeX output -------------------------------------------------
176174

177175
# The paper size ('letter' or 'a4').
178176
#latex_paper_size = 'letter'
179177

180178
# The font size ('10pt', '11pt' or '12pt').
181179
#latex_font_size = '10pt'
182180

183-
# Grouping the document tree into LaTeX files. List of tuples
184-
# (source start file, target name, title, author, documentclass [howto/manual]).
185-
latex_documents = [
186-
('index', 'Freeseer.tex', u'Freeseer Documentation',
187-
u'Free and Open Source Software Learning Centre', 'manual'),
188-
]
181+
# Grouping the document tree into LaTeX files. Takes a list of tuples.
182+
latex_documents = [(
183+
'index', # source start file
184+
'Freeseer.tex', # target name
185+
u'Freeseer Documentation', # title
186+
u'Free and Open Source Software Learning Centre', # author
187+
'manual' # documentclass [howto/manual]
188+
)]
189189

190190
# The name of an image file (relative to this directory) to place at the top of
191191
# the title page.
@@ -211,7 +211,7 @@
211211
#latex_domain_indices = True
212212

213213

214-
# -- Options for manual page output --------------------------------------------
214+
# -- Options for manual page output -------------------------------------------
215215

216216
# One entry per manual page. List of tuples
217217
# (source start file, name, description, authors, manual section).

0 commit comments

Comments
 (0)