aboutsummaryrefslogtreecommitdiffstats
path: root/docs/conf.py
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-08-07 08:12:16 -0700
committerAlex Gaynor <alex.gaynor@gmail.com>2013-08-07 08:12:16 -0700
commitd21da6771942eb4675b85c4465efadc8035c911d (patch)
tree43f35b70e2d5702d33d516e075bbbc1ca81cee8e /docs/conf.py
parent22a425f8d68da1b78e18fb4f2a8e991f3d083188 (diff)
downloadcryptography-d21da6771942eb4675b85c4465efadc8035c911d.tar.gz
cryptography-d21da6771942eb4675b85c4465efadc8035c911d.tar.bz2
cryptography-d21da6771942eb4675b85c4465efadc8035c911d.zip
Pep8 corrections to docs/conf.py
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py53
1 files changed, 28 insertions, 25 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 183145f9..03a6f78d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -3,7 +3,7 @@
# Cryptography documentation build configuration file, created by
# sphinx-quickstart on Tue Aug 6 19:19:14 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,21 +11,23 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, 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
# 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.viewcode']
+# 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.viewcode',
+]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -66,7 +68,7 @@ release = '0.1dev'
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
-# 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.
@@ -87,7 +89,7 @@ pygments_style = 'sphinx'
#modindex_common_prefix = []
-# -- 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.
@@ -167,24 +169,24 @@ html_static_path = ['_static']
htmlhelp_basename = 'Cryptographydoc'
-# -- 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]).
+# (source start file, target name, title, author, documentclass [howto/manual])
latex_documents = [
- ('index', 'Cryptography.tex', u'Cryptography Documentation',
- u'Individual Contributors', 'manual'),
+ ('index', 'Cryptography.tex', u'Cryptography Documentation',
+ u'Individual Contributors', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -208,28 +210,29 @@ 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', 'cryptography', u'Cryptography Documentation',
- [u'Individual Contributors'], 1)
+ [u'Individual Contributors'], 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,
# dir menu entry, description, category)
texinfo_documents = [
- ('index', 'Cryptography', u'Cryptography Documentation',
- u'Individual Contributors', 'Cryptography', 'One line description of project.',
- 'Miscellaneous'),
+ ('index', 'Cryptography', u'Cryptography Documentation',
+ u'Individual Contributors', 'Cryptography',
+ 'One line description of project.',
+ 'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.