pep8 for setup and sphinx conf py files.

9 years ago · 356e4b89f8
parent 9b2800b614
commit 356e4b89f8
2 changed files with 77 additions and 72 deletions
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@ -15,17 +15,20 @@

 import sys
 import os
+import cdist.version
+import sphinx_rtd_theme

 # 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('.'))
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(os.path.realpath(__file__)), "../../")))
+# sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath(os.path.join(
+    os.path.dirname(os.path.realpath(__file__)), "../../")))

 # -- General configuration ------------------------------------------------

 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# 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
@ -43,22 +46,21 @@ templates_path = ['_templates']
 source_suffix = ['.rst']

 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'

 # The master toctree document.
 master_doc = 'index'

 # General information about the project.
 project = 'cdist'
-#copyright = '2016, Darko Poljak'
-#author = 'Darko Poljak'
+# copyright = '2016, Darko Poljak'
+# author = 'Darko Poljak'

 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-import cdist.version
 version = cdist.version.VERSION
 # The full version, including alpha/beta/rc tags.
 release = version
@ -72,9 +74,9 @@ language = None

 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'

 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@ -83,27 +85,27 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

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

 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True

 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True

 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False

 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'

 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []

 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False

 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@ -113,33 +115,33 @@ todo_include_todos = False

 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-import sphinx_rtd_theme
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}

 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []

 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
-#html_title = 'cdist-docs v0.0.1'
+# html_title = 'cdist-docs v0.0.1'

 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None

 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None

 # The name of an image file (relative to this directory) to use as a favicon of
-# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# the docs.  This file should be a Windows icon file (.ico)
+# being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None

 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@ -149,84 +151,84 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []

 # If not None, a 'Last updated on:' timestamp is inserted at every page
 # bottom, using the given strftime format.
 # The empty string is equivalent to '%b %d, %Y'.
-#html_last_updated_fmt = None
+# html_last_updated_fmt = None

 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True

 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}

 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}

 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True

 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True

 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False

 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True

 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True

 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True

 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''

 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-#html_file_suffix = ""
+# html_file_suffix = None
+# html_file_suffix = ""

 # Language to be used for generating the HTML full-text search index.
 # Sphinx supports the following languages:
 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
 #   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
-#html_search_language = 'en'
+# html_search_language = 'en'

 # A dictionary with options for the search language support, empty by default.
 # 'ja' uses this config value.
 # 'zh' user can custom change `jieba` dictionary path.
-#html_search_options = {'type': 'default'}
+# html_search_options = {'type': 'default'}

 # The name of a javascript file (relative to the configuration directory) that
 # implements a search results scorer. If empty, the default will be used.
-#html_search_scorer = 'scorer.js'
+# html_search_scorer = 'scorer.js'

 # Output file base name for HTML help builder.
 htmlhelp_basename = 'cdistdoc'

 # -- Options for LaTeX output ---------------------------------------------

-latex_elements = {
+# latex_elements = {
 # The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+# 'papersize': 'letterpaper',

 # The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+# 'pointsize': '10pt',

 # Additional stuff for the LaTeX preamble.
-#'preamble': '',
+# 'preamble': '',

 # Latex figure (float) alignment
-#'figure_align': 'htbp',
-}
+# 'figure_align': 'htbp',
+# }

 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
@ -238,23 +240,23 @@ latex_documents = [

 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None

 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False

 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False

 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False

 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []

 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True


 # -- Options for manual page output ---------------------------------------
@ -272,20 +274,20 @@ for mandir, section in mandirs:
            froot, fext = os.path.splitext(fname)
            if fext == '.rst':
                man_page = (os.path.join('man' + str(section), froot),
-                        froot, '', [], section)
+                            froot, '', [], section)
                man_pages.append(man_page)

-#man_pages = [
+# man_pages = [
 #    ('cdist-type', 'cdist-type', 'cdist-type documentation',
 #         [author], 1),
 #    ('man7/cdist-type__file', 'cdist-type__file',
 #        '', [], 1),
 #    ('cdist-type__directory', 'cdist-type__directory',
 #        'cdist-type__directory documentation', [author], 1),
-#]
+# ]

 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False


 # -- Options for Texinfo output -------------------------------------------
@ -300,13 +302,13 @@ texinfo_documents = [
 ]

 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []

 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True

 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'

 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
--- a/setup.py
+++ b/setup.py
@ -3,6 +3,7 @@ import cdist
 import os
 import re

+
 def data_finder(data_dir):
    entries = []
    for name in os.listdir(data_dir):
@ -29,17 +30,18 @@ os.chdir("cdist")
 package_data = data_finder("conf")
 os.chdir(cur)

+
 setup(
-    name = "cdist",
-    packages = ["cdist", "cdist.core", "cdist.exec", "cdist.util" ],
+    name="cdist",
+    packages=["cdist", "cdist.core", "cdist.exec", "cdist.util", ],
    package_data={'cdist': package_data},
-    scripts = ["scripts/cdist"],
-    version = cdist.version.VERSION,
-    description = "A Usable Configuration Management System",
-    author = "Nico Schottelius",
-    author_email = "nico-cdist-pypi@schottelius.org",
-    url = "http://www.nico.schottelius.org/software/cdist/",
-    classifiers = [
+    scripts=["scripts/cdist"],
+    version=cdist.version.VERSION,
+    description="A Usable Configuration Management System",
+    author="Nico Schottelius",
+    author_email="nico-cdist-pypi@schottelius.org",
+    url="http://www.nico.schottelius.org/software/cdist/",
+    classifiers=[
        "Development Status :: 6 - Mature",
        "Environment :: Console",
        "Intended Audience :: System Administrators",
@ -57,9 +59,10 @@ setup(
        "Topic :: System :: Software Distribution",
        "Topic :: Utilities"
    ],
-    long_description = '''
+    long_description='''
        cdist is a usable configuration management system.
-        It adheres to the KISS principle and is being used in small up to enterprise grade environments.
+        It adheres to the KISS principle and is being used in small up to
+        enterprise grade environments.
        cdist is an alternative to other configuration management systems like
        cfengine, bcfg2, chef and puppet.
    '''