diff --git a/doc/tools/apigen.py b/doc/tools/apigen.py index 4e6b70f3..43245f7b 100644 --- a/doc/tools/apigen.py +++ b/doc/tools/apigen.py @@ -173,7 +173,7 @@ class ApiDocWriter(object): functions, classes = self._parse_lines(f) f.close() return functions, classes - + def _parse_lines(self, linesource): ''' Parse lines of text for functions and classes ''' functions = [] @@ -260,8 +260,8 @@ class ApiDocWriter(object): '\n' \ ' .. automethod:: __init__\n' # if multi_fx: - ad += '\n' + 'Functions' + '\n' + \ - self.rst_section_levels[2] * 9 + '\n\n' +# ad += '\n' + 'Functions' + '\n' + \ +# self.rst_section_levels[2] * 9 + '\n\n' # elif len(functions) and multi_class: # ad += '\n' + 'Function' + '\n' + \ # self.rst_section_levels[2] * 8 + '\n\n' @@ -304,7 +304,7 @@ class ApiDocWriter(object): elif match_type == 'package': patterns = self.package_skip_patterns else: - raise ValueError('Cannot interpret match type "%s"' + raise ValueError('Cannot interpret match type "%s"' % match_type) # Match to URI without package name L = len(self.package_name) @@ -320,7 +320,7 @@ class ApiDocWriter(object): return True def discover_modules(self): - ''' Return module sequence discovered from ``self.package_name`` + ''' Return module sequence discovered from ``self.package_name`` Parameters @@ -341,7 +341,7 @@ class ApiDocWriter(object): >>> dw.package_skip_patterns.append('\.util$') >>> 'sphinx.util' in dw.discover_modules() False - >>> + >>> ''' modules = [self.package_name] # raw directory parsing @@ -364,7 +364,7 @@ class ApiDocWriter(object): self._survives_exclude(module_uri, 'module')): modules.append(module_uri) return sorted(modules) - + def write_modules_api(self, modules,outdir): # write the list written_modules = [] @@ -389,7 +389,7 @@ class ApiDocWriter(object): outdir : string Directory name in which to store files We create automatic filenames for each module - + Returns ------- None @@ -403,7 +403,7 @@ class ApiDocWriter(object): # compose list of modules modules = self.discover_modules() 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