diff --git a/docs/conf.py b/docs/conf.py index 6c13f4b..d8fd835 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # -# 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. @@ -9,7 +9,8 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os +import sys +import os # This environment variable makes decorators not decorate functions, so their # signatures in the generated documentation are still correct @@ -21,13 +22,13 @@ os.environ['GENERATING_DOCUMENTATION'] = "flake8" sys.path.insert(0, os.path.abspath('..')) import flake8 -# -- 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. +# 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'] # Add any paths that contain templates here, relative to this directory. @@ -69,7 +70,8 @@ release = version # 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. @@ -90,7 +92,7 @@ exclude_patterns = ['_build'] #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. @@ -115,7 +117,6 @@ html_theme = 'nature' # 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. @@ -134,7 +135,6 @@ html_theme = 'nature' # typographically correct entities. #html_use_smartypants = True -# Custom sidebar templates, maps document names to template names. # Custom sidebar templates, maps document names to template names. #html_sidebars = {} @@ -172,7 +172,7 @@ html_theme = 'nature' htmlhelp_basename = 'flake8_doc' -# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output ------------------------------------------------- # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' @@ -181,10 +181,11 @@ htmlhelp_basename = 'flake8_doc' #latex_font_size = '10pt' # 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', 'flake8.tex', u'flake8 Documentation', - u'Tarek Ziade', 'manual'), + ('index', 'flake8.tex', u'flake8 Documentation', + u'Tarek Ziade', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -211,7 +212,7 @@ 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). @@ -223,15 +224,16 @@ man_pages = [ # 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', 'flake8', u'flake8 Documentation', u'Tarek Ziade', - 'flake8', 'Code checking using pep8, pyflakes and mccabe', - 'Miscellaneous'), + ('index', 'flake8', u'flake8 Documentation', u'Tarek Ziade', + 'flake8', 'Code checking using pep8, pyflakes and mccabe', + 'Miscellaneous'), ] # Documents to append as an appendix to all manuals.