STY: PEP8 in doc/tools

Author: grlee77

doc/tools/apigen.py

@@ -40,7 +40,7 @@ def __init__(self,
                  rst_extension='.txt',
                  package_skip_patterns=None,
                  module_skip_patterns=None,
-                 other_defines = True
+                 other_defines=True
                  ):
         ''' Initialize package for parsing
 
@@ -162,7 +162,7 @@ def _uri2path(self, uri):
         path = path.replace('.', os.path.sep)
         path = os.path.join(self.root_path, path)
         # XXX maybe check for extensions as well?
-        if os.path.exists(path + '.py'): # file
+        if os.path.exists(path + '.py'):  # file
             path += '.py'
         elif os.path.exists(os.path.join(path, '__init__.py')):
             path = os.path.join(path, '__init__.py')
@@ -184,7 +184,7 @@ def _parse_module(self, uri):
         if filename is None:
             print(filename, 'erk')
             # nothing that we could handle here.
-            return ([],[])
+            return ([], [])
 
         f = open(filename, 'rt')
         functions, classes = self._parse_lines(f)
@@ -276,7 +276,7 @@ def generate_api_doc(self, uri):
 
         # Make a shorter version of the uri that omits the package name for
         # titles
-        uri_short = re.sub(r'^%s\.' % self.package_name,'',uri)
+        uri_short = re.sub(r'^%s\.' % self.package_name, '', uri)
 
         head = '.. AUTO-GENERATED FILE -- DO NOT EDIT!\n\n'
         body = ''
@@ -300,10 +300,10 @@ def generate_api_doc(self, uri):
             body += '\n.. autoclass:: ' + c + '\n'
             # must NOT exclude from index to keep cross-refs working
             body += '  :members:\n' \
-                  '  :undoc-members:\n' \
-                  '  :show-inheritance:\n' \
-                  '\n' \
-                  '  .. automethod:: __init__\n\n'
+                '  :undoc-members:\n' \
+                '  :show-inheritance:\n' \
+                '\n' \
+                '  .. automethod:: __init__\n\n'
         head += '.. autosummary::\n\n'
         for f in classes + functions:
             head += '   ' + f + '\n'
@@ -402,7 +402,7 @@ def discover_modules(self):
                 package_uri = '.'.join((root_uri, subpkg_name))
                 package_path = self._uri2path(package_uri)
                 if (package_path and
-                    self._survives_exclude(package_uri, 'package')):
+                        self._survives_exclude(package_uri, 'package')):
                     modules.append(package_uri)
 
         return sorted(modules)
@@ -467,7 +467,7 @@ def write_api_docs(self, outdir):
             os.mkdir(outdir)
         # compose list of modules
         modules = self.discover_modules()
-        self.write_modules_api(modules,outdir)
+        self.write_modules_api(modules, outdir)
 
     def write_index(self, outdir, froot='gen', relative_to=None):
         """Make a reST API index file from written files
@@ -493,10 +493,11 @@ def write_index(self, outdir, froot='gen', relative_to=None):
         path = os.path.join(outdir, froot+self.rst_extension)
         # Path written into index is relative to rootpath
         if relative_to is not None:
-            relpath = (outdir + os.path.sep).replace(relative_to + os.path.sep, '')
+            relpath = (
+                outdir + os.path.sep).replace(relative_to + os.path.sep, '')
         else:
             relpath = outdir
-        idx = open(path,'wt')
+        idx = open(path, 'wt')
         w = idx.write
         w('.. AUTO-GENERATED FILE -- DO NOT EDIT!\n\n')
 
@@ -505,5 +506,5 @@ def write_index(self, outdir, froot='gen', relative_to=None):
         w("=" * len(title) + "\n\n")
         w('.. toctree::\n\n')
         for f in self.written_modules:
-            w('   %s\n' % os.path.join(relpath,f))
+            w('   %s\n' % os.path.join(relpath, f))
         idx.close()

doc/tools/build_modref_templates.py

@@ -14,7 +14,8 @@
 # version comparison
 from distutils.version import LooseVersion as V
 
-#*****************************************************************************
+# *****************************************************************************
+
 
 def abort(error):
     print('*WARNING* API documentation not generated: %s' % error)