Propose lint conf.py

docs/conf.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+'''
 #
 # Python-Fitbit documentation build configuration file, created by
 # sphinx-quickstart on Wed Mar 14 18:51:57 2012.
@@ -10,51 +11,52 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
-import sys, os
+'''
+import sys
+import os
+import fitbit
 
 # 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 = [
+EXTENSIONS = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+TEMPLATES_PATH = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+SOURCE_SUFFIX = '.rst'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+MASTER_DOC = 'index'
 
 # General information about the project.
-import fitbit
-project = u'Python-Fitbit'
-copyright = fitbit.__copyright__
+PROJECT = u'Python-Fitbit'
+COPYRIGHT = fitbit.__copyright__
 
 # 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.
-version = fitbit.__version__
+VERSION = fitbit.__version__
 # The full version, including alpha/beta/rc tags.
-release = fitbit.__release__
+RELEASE = fitbit.__release__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -68,7 +70,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+EXCLUDE_PATTERNS = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
@@ -85,17 +87,17 @@
 #show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+PYGMENTS_STYLE = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
 #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.
-html_theme = 'alabaster'
+HTML_THEME = 'alabaster'
 
 # 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
@@ -124,7 +126,7 @@
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+HTML_STATIC_PATH = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -168,27 +170,27 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Python-Fitbitdoc'
+HTMLHELP_BASENAME = 'Python-Fitbitdoc'
 
 
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output --------------------------------------------
 
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+LATEX_ELEMENTS = {
+    # 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]).
-latex_documents = [
-  ('index', 'Python-Fitbit.tex', u'Python-Fitbit Documentation',
-   u'Issac Kelly, Percy Perez, Brad Pitcher', 'manual'),
+LATEX_DOCUMENTS = [
+    ('index', 'Python-Fitbit.tex', u'Python-Fitbit Documentation',
+     u'Issac Kelly, Percy Perez, Brad Pitcher', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -212,11 +214,11 @@
 #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 = [
+MAN_PAGES = [
     ('index', 'python-fitbit', u'Python-Fitbit Documentation',
      [u'Issac Kelly, Percy Perez, Brad Pitcher'], 1)
 ]
@@ -225,15 +227,16 @@
 #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', 'Python-Fitbit', u'Python-Fitbit Documentation',
-   u'Issac Kelly, Percy Perez, Brad Pitcher', 'Python-Fitbit', 'Fitbit API Python Client Implementation',
-   'Miscellaneous'),
+TEXINFO_DOCUMENTS = [
+    ('index', 'Python-Fitbit', u'Python-Fitbit Documentation',
+     u'Issac Kelly, Percy Perez, Brad Pitcher', 'Python-Fitbit',
+     'Fitbit API Python Client Implementation',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.