diff options
36 files changed, 554 insertions, 369 deletions
diff --git a/sphinx/application.py b/sphinx/application.py index 1ad7823f3..761188049 100644 --- a/sphinx/application.py +++ b/sphinx/application.py @@ -22,7 +22,8 @@ import sphinx from sphinx.roles import xfileref_role, innernodetypes from sphinx.config import Config from sphinx.builders import BUILTIN_BUILDERS -from sphinx.directives import desc_directive, target_directive, additional_xref_types +from sphinx.directives import desc_directive, target_directive, \ + additional_xref_types from sphinx.environment import SphinxStandaloneReader from sphinx.util.console import bold @@ -152,7 +153,8 @@ class Sphinx(object): self._warning.write('WARNING: %s\n' % message) except UnicodeEncodeError: encoding = getattr(self._warning, 'encoding', 'ascii') - self._warning.write(('WARNING: %s\n' % message).encode(encoding, 'replace')) + self._warning.write(('WARNING: %s\n' % message).encode(encoding, + 'replace')) def info(self, message='', nonl=False): try: @@ -171,7 +173,8 @@ class Sphinx(object): try: mod = __import__(extension, None, None, ['setup']) except ImportError, err: - raise ExtensionError('Could not import extension %s' % extension, err) + raise ExtensionError('Could not import extension %s' % extension, + err) if hasattr(mod, 'setup'): mod.setup(self) @@ -181,15 +184,18 @@ class Sphinx(object): module, name = objname.rsplit('.', 1) except ValueError, err: raise ExtensionError('Invalid full object name %s' % objname + - (source and ' (needed for %s)' % source or ''), err) + (source and ' (needed for %s)' % source or ''), + err) try: return getattr(__import__(module, None, None, [name]), name) except ImportError, err: raise ExtensionError('Could not import %s' % module + - (source and ' (needed for %s)' % source or ''), err) + (source and ' (needed for %s)' % source or ''), + err) except AttributeError, err: raise ExtensionError('Could not find %s' % objname + - (source and ' (needed for %s)' % source or ''), err) + (source and ' (needed for %s)' % source or ''), + err) # event interface @@ -229,13 +235,15 @@ class Sphinx(object): def add_builder(self, builder): if not hasattr(builder, 'name'): - raise ExtensionError('Builder class %s has no "name" attribute' % builder) + raise ExtensionError('Builder class %s has no "name" attribute' + % builder) if builder.name in self.builderclasses: if isinstance(self.builderclasses[builder.name], tuple): raise ExtensionError('Builder %r is a builtin builder' % builder.name) else: - raise ExtensionError('Builder %r already exists (in module %s)' % ( + raise ExtensionError( + 'Builder %r already exists (in module %s)' % ( builder.name, self.builderclasses[builder.name].__module__)) self.builderclasses[builder.name] = builder @@ -255,8 +263,8 @@ class Sphinx(object): try: visit, depart = val except ValueError: - raise ExtensionError('Value for key %r must be a (visit, depart) ' - 'function tuple' % key) + raise ExtensionError('Value for key %r must be a ' + '(visit, depart) function tuple' % key) if key == 'html': from sphinx.writers.html import HTMLTranslator as translator elif key == 'latex': @@ -281,7 +289,8 @@ class Sphinx(object): def add_description_unit(self, directivename, rolename, indextemplate='', parse_node=None, ref_nodeclass=None): - additional_xref_types[directivename] = (rolename, indextemplate, parse_node) + additional_xref_types[directivename] = (rolename, indextemplate, + parse_node) directives.register_directive(directivename, desc_directive) roles.register_canonical_role(rolename, xfileref_role) if ref_nodeclass is not None: diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index 5179cba0c..ee13947ed 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -97,20 +97,20 @@ class Builder(object): def get_relative_uri(self, from_, to, typ=None): """ - Return a relative URI between two source filenames. May raise environment.NoUri - if there's no way to return a sensible URI. + Return a relative URI between two source filenames. May raise + environment.NoUri if there's no way to return a sensible URI. """ return relative_uri(self.get_target_uri(from_), self.get_target_uri(to, typ)) def get_outdated_docs(self): """ - Return an iterable of output files that are outdated, or a string describing - what an update build will build. + Return an iterable of output files that are outdated, or a string + describing what an update build will build. - If the builder does not output individual files corresponding to source files, - return a string here. If it does, return an iterable of those files that need - to be written. + If the builder does not output individual files corresponding to + source files, return a string here. If it does, return an iterable + of those files that need to be written. """ raise NotImplementedError @@ -142,7 +142,8 @@ class Builder(object): break else: self.warn('%s:%s: no matching candidate for image URI %r' % - (node.source, getattr(node, 'lineno', ''), node['uri'])) + (node.source, getattr(node, 'lineno', ''), + node['uri'])) continue node['uri'] = candidate else: @@ -161,10 +162,10 @@ class Builder(object): """ self.translator = None if self.config.language is not None: - self.info(bold('loading translations [%s]... ' % self.config.language), - nonl=True) + self.info(bold('loading translations [%s]... ' % + self.config.language), nonl=True) locale_dirs = [path.join(package_dir, 'locale')] + \ - [path.join(self.srcdir, x) for x in self.config.locale_dirs] + [path.join(self.srcdir, x) for x in self.config.locale_dirs] for dir_ in locale_dirs: try: trans = gettext.translation('sphinx', localedir=dir_, @@ -200,10 +201,12 @@ class Builder(object): self.info('not found') else: self.info('failed: %s' % err) - self.env = BuildEnvironment(self.srcdir, self.doctreedir, self.config) + self.env = BuildEnvironment(self.srcdir, self.doctreedir, + self.config) self.env.find_files(self.config) else: - self.env = BuildEnvironment(self.srcdir, self.doctreedir, self.config) + self.env = BuildEnvironment(self.srcdir, self.doctreedir, + self.config) self.env.find_files(self.config) self.env.set_warnfunc(self.warn) @@ -241,7 +244,8 @@ class Builder(object): def build(self, docnames, summary=None, method='update'): """ - Main build method. First updates the environment, and then calls :meth:`write`. + Main build method. First updates the environment, and then + calls :meth:`write`. """ if summary: self.info(bold('building [%s]: ' % self.name), nonl=1) @@ -252,12 +256,15 @@ class Builder(object): warnings = [] self.env.set_warnfunc(warnings.append) self.info(bold('updating environment: '), nonl=1) - iterator = self.env.update(self.config, self.srcdir, self.doctreedir, self.app) + iterator = self.env.update(self.config, self.srcdir, + self.doctreedir, self.app) # the first item in the iterator is a summary message self.info(iterator.next()) - for docname in self.status_iterator(iterator, 'reading sources... ', purple): + for docname in self.status_iterator(iterator, 'reading sources... ', + purple): updated_docnames.append(docname) - # nothing further to do, the environment has already done the reading + # nothing further to do, the environment has already + # done the reading for warning in warnings: if warning.strip(): self.warn(warning) @@ -278,12 +285,14 @@ class Builder(object): self.info(bold('no targets are out of date.')) return - # another indirection to support builders that don't build files individually + # another indirection to support builders that don't build + # files individually self.write(docnames, updated_docnames, method) # finish (write static files etc.) self.finish() - status = self.app.statuscode == 0 and 'succeeded' or 'finished with problems' + status = (self.app.statuscode == 0 and 'succeeded' + or 'finished with problems') if self.app._warncount: self.info(bold('build %s, %s warning%s.' % (status, self.app._warncount, diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py index 8770d49b0..6f057b49d 100644 --- a/sphinx/builders/changes.py +++ b/sphinx/builders/changes.py @@ -55,7 +55,8 @@ class ChangesBuilder(Builder): if not descname: continue if context: - entry = '<b>%s</b>: <i>%s:</i> %s' % (descname, ttext, context) + entry = '<b>%s</b>: <i>%s:</i> %s' % (descname, ttext, + context) else: entry = '<b>%s</b>: <i>%s</i>.' % (descname, ttext) apichanges.append((entry, docname, lineno)) @@ -65,10 +66,12 @@ class ChangesBuilder(Builder): if not descname: descname = _('Module level') if context: - entry = '<b>%s</b>: <i>%s:</i> %s' % (descname, ttext, context) + entry = '<b>%s</b>: <i>%s:</i> %s' % (descname, ttext, + context) else: entry = '<b>%s</b>: <i>%s</i>.' % (descname, ttext) - libchanges.setdefault(module, []).append((entry, docname, lineno)) + libchanges.setdefault(module, []).append((entry, docname, + lineno)) else: if not context: continue @@ -119,7 +122,10 @@ class ChangesBuilder(Builder): f = codecs.open(targetfn, 'w', 'latin1') try: text = ''.join(hl(i+1, line) for (i, line) in enumerate(lines)) - ctx = {'filename': self.env.doc2path(docname, None), 'text': text} + ctx = { + 'filename': self.env.doc2path(docname, None), + 'text': text + } f.write(self.templates.render('changes/rstsource.html', ctx)) finally: f.close() diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index bfbe299a9..6d9a2ba87 100644 --- a/sphinx/builders/html.py +++ b/sphinx/builders/html.py @@ -27,7 +27,8 @@ from sphinx.search import js_index from sphinx.builders import Builder, ENV_PICKLE_FILENAME from sphinx.highlighting import PygmentsBridge from sphinx.util.console import bold -from sphinx.writers.html import HTMLWriter, HTMLTranslator, SmartyPantsHTMLTranslator +from sphinx.writers.html import HTMLWriter, HTMLTranslator, \ + SmartyPantsHTMLTranslator try: import json @@ -88,7 +89,8 @@ class StandaloneHTMLBuilder(Builder): def init_translator_class(self): if self.config.html_translator_class: self.translator_class = self.app.import_object( - self.config.html_translator_class, 'html_translator_class setting') + self.config.html_translator_class, + 'html_translator_class setting') elif self.config.html_use_smartypants: self.translator_class = SmartyPantsHTMLTranslator else: @@ -141,7 +143,8 @@ class StandaloneHTMLBuilder(Builder): if self.config.html_use_index: rellinks.append(('genindex', _('General Index'), 'I', _('index'))) if self.config.html_use_modindex and self.env.modules: - rellinks.append(('modindex', _('Global Module Index'), 'M', _('modules'))) + rellinks.append(('modindex', _('Global Module Index'), + 'M', _('modules'))) if self.config.html_style is not None: stylename = self.config.html_style @@ -184,18 +187,23 @@ class StandaloneHTMLBuilder(Builder): titles = self.env.titles if related and related[2]: try: - next = {'link': self.get_relative_uri(docname, related[2]), - 'title': self.render_partial(titles[related[2]])['title']} + next = { + 'link': self.get_relative_uri(docname, related[2]), + 'title': self.render_partial(titles[related[2]])['title'] + } rellinks.append((related[2], next['title'], 'N', _('next'))) except KeyError: next = None if related and related[1]: try: - prev = {'link': self.get_relative_uri(docname, related[1]), - 'title': self.render_partial(titles[related[1]])['title']} + prev = { + 'link': self.get_relative_uri(docname, related[1]), + 'title': self.render_partial(titles[related[1]])['title'] + } rellinks.append((related[1], prev['title'], 'P', _('previous'))) except KeyError: - # the relation is (somehow) not in the TOC tree, handle that gracefully + # the relation is (somehow) not in the TOC tree, handle + # that gracefully prev = None while related and related[0]: try: @@ -219,6 +227,9 @@ class StandaloneHTMLBuilder(Builder): # metadata for the document meta = self.env.metadata.get(docname) + # TOC + toc = self.render_partial(self.env.get_toc_for(docname))['fragment'] + return dict( parents = parents, prev = prev, @@ -229,7 +240,7 @@ class StandaloneHTMLBuilder(Builder): metatags = metatags, rellinks = rellinks, sourcename = sourcename, - toc = self.render_partial(self.env.get_toc_for(docname))['fragment'], + toc = toc, # only display a TOC if there's more than one item to show display_toc = (self.env.toc_num_entries[docname] > 1), ) @@ -272,12 +283,15 @@ class StandaloneHTMLBuilder(Builder): self.info(' genindex', nonl=1) if self.config.html_split_index: - self.handle_page('genindex', genindexcontext, 'genindex-split.html') - self.handle_page('genindex-all', genindexcontext, 'genindex.html') + self.handle_page('genindex', genindexcontext, + 'genindex-split.html') + self.handle_page('genindex-all', genindexcontext, + 'genindex.html') for (key, entries), count in zip(genindex, indexcounts): ctx = {'key': key, 'entries': entries, 'count': count, 'genindexentries': genindex} - self.handle_page('genindex-' + key, ctx, 'genindex-single.html') + self.handle_page('genindex-' + key, ctx, + 'genindex-single.html') else: self.handle_page('genindex', genindexcontext, 'genindex.html') @@ -318,11 +332,13 @@ class StandaloneHTMLBuilder(Builder): elif not pmn.startswith(tn): # submodule without parent in list, add dummy entry cg += 1 - modindexentries.append([tn, True, cg, False, '', '', [], False]) + modindexentries.append([tn, True, cg, + False, '', '', [], False]) else: num_toplevels += 1 cg += 1 - modindexentries.append([mn, False, cg, (tn != mn), fn, sy, pl, dep]) + modindexentries.append([mn, False, cg, (tn != mn), + fn, sy, pl, dep]) pmn = mn fl = mn[0].lower() platforms = sorted(platforms) @@ -430,7 +446,8 @@ class StandaloneHTMLBuilder(Builder): if docname not in self.env.all_docs: yield docname continue - targetname = self.env.doc2path(docname, self.outdir, self.out_suffix) + targetname = self.env.doc2path(docname, self.outdir, + self.out_suffix) try: targetmtime = path.getmtime(targetname) except Exception: @@ -454,8 +471,9 @@ class StandaloneHTMLBuilder(Builder): f.close() except (IOError, OSError, ValueError): if keep: - self.warn("search index couldn't be loaded, but not all documents " - "will be built: the index will be incomplete.") + self.warn('search index couldn\'t be loaded, but not all ' + 'documents will be built: the index will be ' + 'incomplete.') # delete all entries for files that will be rebuilt self.indexer.prune(keep) @@ -485,12 +503,15 @@ class StandaloneHTMLBuilder(Builder): ctx['customsidebar'] = self.config.html_sidebars.get(pagename) ctx.update(addctx) - self.app.emit('html-page-context', pagename, templatename, ctx, event_arg) + self.app.emit('html-page-context', pagename, templatename, + ctx, event_arg) output = self.templates.render(templatename, ctx) if not outfilename: - outfilename = path.join(self.outdir, os_path(pagename) + self.out_suffix) - ensuredir(path.dirname(outfilename)) # normally different from self.outdir + outfilename = path.join(self.outdir, + os_path(pagename) + self.out_suffix) + # outfilename's path is in general different from self.outdir + ensuredir(path.dirname(outfilename)) try: f = codecs.open(outfilename, 'w', 'utf-8') try: @@ -501,7 +522,8 @@ class StandaloneHTMLBuilder(Builder): self.warn("Error writing file %s: %s" % (outfilename, err)) if self.copysource and ctx.get('sourcename'): # copy the source file for the "show source" link - source_name = path.join(self.outdir, '_sources', os_path(ctx['sourcename'])) + source_name = path.join(self.outdir, '_sources', + os_path(ctx['sourcename'])) ensuredir(path.dirname(source_name)) shutil.copyfile(self.env.doc2path(pagename), source_name) @@ -509,8 +531,8 @@ class StandaloneHTMLBuilder(Builder): self.info(bold('dumping search index... '), nonl=True) self.indexer.prune(self.env.all_docs) searchindexfn = path.join(self.outdir, self.searchindex_filename) - # first write to a temporary file, so that if dumping fails, the existing - # index won't be overwritten + # first write to a temporary file, so that if dumping fails, + # the existing index won't be overwritten f = open(searchindexfn + '.tmp', 'wb') try: self.indexer.dump(f, self.indexer_format) @@ -528,7 +550,8 @@ class StandaloneHTMLBuilder(Builder): for modname, info in self.env.modules.iteritems(): f.write('%s mod %s\n' % (modname, self.get_target_uri(info[0]))) for refname, (docname, desctype) in self.env.descrefs.iteritems(): - f.write('%s %s %s\n' % (refname, desctype, self.get_target_uri(docname))) + f.write('%s %s %s\n' % (refname, desctype, + self.get_target_uri(docname))) finally: f.close() self.info('done') @@ -568,9 +591,11 @@ class SerializingHTMLBuilder(StandaloneHTMLBuilder): ctx['customsidebar'] = sidebarfile if not outfilename: - outfilename = path.join(self.outdir, os_path(pagename) + self.out_suffix) + outfilename = path.join(self.outdir, + os_path(pagename) + self.out_suffix) - self.app.emit('html-page-context', pagename, templatename, ctx, event_arg) + self.app.emit('html-page-context', pagename, templatename, + ctx, event_arg) ensuredir(path.dirname(outfilename)) f = open(outfilename, 'wb') @@ -638,7 +663,7 @@ class JSONHTMLBuilder(SerializingHTMLBuilder): def init(self): if json is None: from sphinx.application import SphinxError - raise SphinxError('The module simplejson (or json in Python >= 2.6) ' - 'is not available. The JSONHTMLBuilder builder ' - 'will not work.') + raise SphinxError( + 'The module simplejson (or json in Python >= 2.6) ' + 'is not available. The JSONHTMLBuilder builder will not work.') SerializingHTMLBuilder.init(self) diff --git a/sphinx/builders/htmlhelp.py b/sphinx/builders/htmlhelp.py index 9baaa2356..8d17f91b8 100644 --- a/sphinx/builders/htmlhelp.py +++ b/sphinx/builders/htmlhelp.py @@ -122,8 +122,8 @@ was will with class HTMLHelpBuilder(StandaloneHTMLBuilder): """ - Builder that also outputs Windows HTML help project, contents and index files. - Adapted from the original Doc/tools/prechm.py. + Builder that also outputs Windows HTML help project, contents and + index files. Adapted from the original Doc/tools/prechm.py. """ name = 'htmlhelp' @@ -166,8 +166,10 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder): for root, dirs, files in os.walk(outdir): staticdir = (root == path.join(outdir, '_static')) for fn in files: - if (staticdir and not fn.endswith('.js')) or fn.endswith('.html'): - print >>f, path.join(root, fn)[olen:].replace(os.sep, '\\') + if (staticdir and not fn.endswith('.js')) or \ + fn.endswith('.html'): + print >>f, path.join(root, fn)[olen:].replace(os.sep, + '\\') finally: f.close() @@ -182,8 +184,8 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder): f.write('<LI> ' + object_sitemap % (_('Global Module Index'), 'modindex.html')) # the TOC - tocdoc = self.env.get_and_resolve_doctree(self.config.master_doc, self, - prune_toctrees=False) + tocdoc = self.env.get_and_resolve_doctree( + self.config.master_doc, self, prune_toctrees=False) def write_toc(node, ullevel=0): if isinstance(node, nodes.list_item): f.write('<LI> ') @@ -204,8 +206,9 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder): elif isinstance(node, addnodes.compact_paragraph): for subnode in node: write_toc(subnode, ullevel) - istoctree = lambda node: isinstance(node, addnodes.compact_paragraph) and \ - node.has_key('toctree') + def istoctree(node): + return isinstance(node, addnodes.compact_paragraph) and \ + node.has_key('toctree') for node in tocdoc.traverse(istoctree): write_toc(node) f.write(contents_footer) @@ -230,7 +233,8 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder): write_param('Local', refs[0]) else: for i, ref in enumerate(refs): - write_param('Name', '[%d] %s' % (i, ref)) # XXX: better title? + # XXX: better title? + write_param('Name', '[%d] %s' % (i, ref)) write_param('Local', ref) f.write('</OBJECT>\n') if subitems: diff --git a/sphinx/builders/latex.py b/sphinx/builders/latex.py index 3b7b0c196..62da7491f 100644 --- a/sphinx/builders/latex.py +++ b/sphinx/builders/latex.py @@ -116,12 +116,12 @@ class LaTeXBuilder(Builder): for includefile in includefiles: try: self.info(darkgreen(includefile) + " ", nonl=1) - subtree = process_tree(includefile, - self.env.get_doctree(includefile)) + subtree = process_tree( + includefile, self.env.get_doctree(includefile)) self.docnames.add(includefile) except Exception: - self.warn('%s: toctree contains ref to nonexisting file %r' % - (docname, includefile)) + self.warn('%s: toctree contains ref to nonexisting ' + 'file %r' % (docname, includefile)) else: sof = addnodes.start_of_file(docname=includefile) sof.children = subtree.children @@ -131,10 +131,12 @@ class LaTeXBuilder(Builder): tree = self.env.get_doctree(indexfile) tree['docname'] = indexfile if toctree_only: - # extract toctree nodes from the tree and put them in a fresh document + # extract toctree nodes from the tree and put them in a + # fresh document new_tree = new_document('<latex output>') new_sect = nodes.section() - new_sect += nodes.title(u'<Set title in conf.py>', u'<Set title in conf.py>') + new_sect += nodes.title(u'<Set title in conf.py>', + u'<Set title in conf.py>') new_tree += new_sect for node in tree.traverse(addnodes.toctree): new_sect += node diff --git a/sphinx/builders/linkcheck.py b/sphinx/builders/linkcheck.py index 5fcda2316..b0fa9ba67 100644 --- a/sphinx/builders/linkcheck.py +++ b/sphinx/builders/linkcheck.py @@ -90,7 +90,8 @@ class CheckExternalLinksBuilder(Builder): self.warn('%s:%s: broken link: %s' % (docname, lineno, uri)) else: self.info(' - ' + purple('redirected') + ' to ' + s) - self.write_entry('redirected', docname, lineno, uri + ' to ' + s) + self.write_entry('redirected', docname, + lineno, uri + ' to ' + s) self.redirected[uri] = (r, s) elif len(uri) == 0 or uri[0:7] == 'mailto:' or uri[0:4] == 'ftp:': return diff --git a/sphinx/builders/qthelp.py b/sphinx/builders/qthelp.py index 855b340eb..7c2af1ef8 100644 --- a/sphinx/builders/qthelp.py +++ b/sphinx/builders/qthelp.py @@ -19,7 +19,8 @@ from docutils import nodes from sphinx import addnodes from sphinx.builders.html import StandaloneHTMLBuilder -_idpattern = re.compile('(?P<title>.+) (\((?P<id>[\w\.]+)( (?P<descr>\w+))?\))$') +_idpattern = re.compile( + r'(?P<title>.+) (\((?P<id>[\w\.]+)( (?P<descr>\w+))?\))$') # Qt Help Collection Project (.qhcp). @@ -149,7 +150,8 @@ class QtHelpBuilder(StandaloneHTMLBuilder): for root, dirs, files in os.walk(outdir): staticdir = (root == path.join(outdir, '_static')) for fn in files: - if (staticdir and not fn.endswith('.js')) or fn.endswith('.html'): + if (staticdir and not fn.endswith('.js')) or \ + fn.endswith('.html'): filename = path.join(root, fn)[olen:] #filename = filename.replace(os.sep, '\\') # XXX projectfiles.append(file_template % {'filename': filename}) diff --git a/sphinx/builders/text.py b/sphinx/builders/text.py index aaafedb47..d243e5c7a 100644 --- a/sphinx/builders/text.py +++ b/sphinx/builders/text.py @@ -31,7 +31,8 @@ class TextBuilder(Builder): if docname not in self.env.all_docs: yield docname continue - targetname = self.env.doc2path(docname, self.outdir, self.out_suffix) + targetname = self.env.doc2path(docname, self.outdir, + self.out_suffix) try: targetmtime = path.getmtime(targetname) except Exception: @@ -54,7 +55,7 @@ class TextBuilder(Builder): destination = StringOutput(encoding='utf-8') self.writer.write(doctree, destination) outfilename = path.join(self.outdir, os_path(docname) + self.out_suffix) - ensuredir(path.dirname(outfilename)) # normally different from self.outdir + ensuredir(path.dirname(outfilename)) try: f = codecs.open(outfilename, 'w', 'utf-8') try: diff --git a/sphinx/cmdline.py b/sphinx/cmdline.py index 20767f0d4..5b57a7c39 100644 --- a/sphinx/cmdline.py +++ b/sphinx/cmdline.py @@ -31,7 +31,8 @@ def usage(argv, msg=None): Sphinx v%s Usage: %s [options] sourcedir outdir [filenames...] Options: -b <builder> -- builder to use; default is html - -a -- write all files; default is to only write new and changed files + -a -- write all files; default is to only write \ +new and changed files -E -- don't use a saved environment, always read all files -d <path> -- path for the cached environment and doctree files (default: outdir/.doctrees) @@ -64,7 +65,8 @@ def main(argv): return 1 if not path.isfile(path.join(srcdir, 'conf.py')) and \ '-c' not in allopts and '-C' not in allopts: - print >>sys.stderr, 'Error: Source directory doesn\'t contain conf.py file.' + print >>sys.stderr, ('Error: Source directory doesn\'t ' + 'contain conf.py file.') return 1 outdir = path.abspath(args[1]) if not path.isdir(outdir): @@ -103,8 +105,8 @@ def main(argv): elif opt == '-c': confdir = path.abspath(val) if not path.isfile(path.join(confdir, 'conf.py')): - print >>sys.stderr, \ - 'Error: Configuration directory doesn\'t contain conf.py file.' + print >>sys.stderr, ('Error: Configuration directory ' + 'doesn\'t contain conf.py file.') return 1 elif opt == '-C': confdir = None @@ -112,8 +114,8 @@ def main(argv): try: key, val = val.split('=') except ValueError: - print >>sys.stderr, \ - 'Error: -D option argument must be in the form name=value.' + print >>sys.stderr, ('Error: -D option argument must be ' + 'in the form name=value.') return 1 try: val = int(val) @@ -124,8 +126,8 @@ def main(argv): try: key, val = val.split('=') except ValueError: - print >>sys.stderr, \ - 'Error: -A option argument must be in the form name=value.' + print >>sys.stderr, ('Error: -A option argument must be ' + 'in the form name=value.') return 1 try: val = int(val) @@ -153,7 +155,8 @@ def main(argv): except KeyboardInterrupt: if use_pdb: import pdb - print >>sys.stderr, darkred('Interrupted while building, starting debugger:') + print >>sys.stderr, darkred('Interrupted while building, ' + 'starting debugger:') traceback.print_exc() pdb.post_mortem(sys.exc_info()[2]) return 1 @@ -167,7 +170,8 @@ def main(argv): else: if isinstance(err, SystemMessage): print >>sys.stderr, darkred('reST markup error:') - print >>sys.stderr, err.args[0].encode('ascii', 'backslashreplace') + print >>sys.stderr, err.args[0].encode('ascii', + 'backslashreplace') elif isinstance(err, SphinxError): print >>sys.stderr, darkred('%s:' % err.category) print >>sys.stderr, err @@ -181,6 +185,6 @@ def main(argv): print >>sys.stderr, ('Please also report this if it was a user ' 'error, so that a better error message ' 'can be provided next time.') - print >>sys.stderr, ('Send reports to sphinx-dev@googlegroups.com. ' - 'Thanks!') + print >>sys.stderr, ('Send reports to ' + 'sphinx-dev@googlegroups.com. Thanks!') return 1 diff --git a/sphinx/config.py b/sphinx/config.py index 5942fcf88..5c3b7dfe6 100644 --- a/sphinx/config.py +++ b/sphinx/config.py @@ -63,7 +63,8 @@ class Config(object): html_logo = (None, False), html_favicon = (None, False), html_static_path = ([], False), - html_last_updated_fmt = (None, False), # the real default is locale-dependent + # the real default is locale-dependent + html_last_updated_fmt = (None, False), html_use_smartypants = (True, False), html_translator_class = (None, False), html_sidebars = ({}, False), diff --git a/sphinx/directives/code.py b/sphinx/directives/code.py index 74ac8e7f0..da68cf2e2 100644 --- a/sphinx/directives/code.py +++ b/sphinx/directives/code.py @@ -18,7 +18,7 @@ from sphinx import addnodes from sphinx.util import parselinenos -# ------ highlight directive -------------------------------------------------------- +# ------ highlight directive --------------------------------------------------- def highlightlang_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): @@ -36,10 +36,11 @@ highlightlang_directive.content = 0 highlightlang_directive.arguments = (1, 0, 0) highlightlang_directive.options = {'linenothreshold': directives.unchanged} directives.register_directive('highlight', highlightlang_directive) -directives.register_directive('highlightlang', highlightlang_directive) # old name +# old name +directives.register_directive('highlightlang', highlightlang_directive) -# ------ code-block directive ------------------------------------------------------- +# ------ code-block directive -------------------------------------------------- def codeblock_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): @@ -56,13 +57,15 @@ directives.register_directive('code-block', codeblock_directive) directives.register_directive('sourcecode', codeblock_directive) -# ------ literalinclude directive --------------------------------------------------- +# ------ literalinclude directive ---------------------------------------------- def literalinclude_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): - """Like .. include:: :literal:, but only warns if the include file is not found.""" + """Like .. include:: :literal:, but only warns if the include file is + not found.""" if not state.document.settings.file_insertion_enabled: - return [state.document.reporter.warning('File insertion disabled', line=lineno)] + return [state.document.reporter.warning('File insertion disabled', + line=lineno)] env = state.document.settings.env rel_fn = arguments[0] source_dir = path.dirname(path.abspath(state_machine.input_lines.source( @@ -133,14 +136,15 @@ def literalinclude_directive(name, arguments, options, content, lineno, state.document.settings.env.note_dependency(rel_fn) return [retnode] -literalinclude_directive.options = {'linenos': directives.flag, - 'language': directives.unchanged_required, - 'encoding': directives.encoding, - 'pyobject': directives.unchanged_required, - 'lines': directives.unchanged_required, - 'start-after': directives.unchanged_required, - 'end-before': directives.unchanged_required, - } +literalinclude_directive.options = { + 'linenos': directives.flag, + 'language': directives.unchanged_required, + 'encoding': directives.encoding, + 'pyobject': directives.unchanged_required, + 'lines': directives.unchanged_required, + 'start-after': directives.unchanged_required, + 'end-before': directives.unchanged_required, +} literalinclude_directive.content = 0 literalinclude_directive.arguments = (1, 0, 0) directives.register_directive('literalinclude', literalinclude_directive) diff --git a/sphinx/directives/desc.py b/sphinx/directives/desc.py index 3ffe048b9..05df4ffad 100644 --- a/sphinx/directives/desc.py +++ b/sphinx/directives/desc.py @@ -17,7 +17,7 @@ from sphinx import addnodes from sphinx.util import ws_re -# ------ information units --------------------------------------------------------- +# ------ information units ----------------------------------------------------- def desc_index_text(desctype, module, name, add_modules): if desctype == 'function': @@ -342,7 +342,8 @@ def parse_c_type(node, ctype): tnode = nodes.Text(part, part) if part[0] in string.ascii_letters+'_' and part not in stopwords: pnode = addnodes.pending_xref( - '', reftype='ctype', reftarget=part, modname=None, classname=None) + '', reftype='ctype', reftarget=part, + modname=None, classname=None) pnode += tnode node += pnode else: @@ -449,8 +450,10 @@ def desc_directive(desctype, arguments, options, content, lineno, if desctype in ('function', 'data', 'class', 'exception', 'method', 'staticmethod', 'classmethod', 'attribute'): - name, clsname = parse_py_signature(signode, sig, desctype, module, env) - elif desctype in ('cfunction', 'cmember', 'cmacro', 'ctype', 'cvar'): + name, clsname = parse_py_signature(signode, sig, + desctype, module, env) + elif desctype in ('cfunction', 'cmember', 'cmacro', + 'ctype', 'cvar'): name = parse_c_signature(signode, sig, desctype) elif desctype == 'cmdoption': optname = parse_option_desc(signode, sig) @@ -463,7 +466,8 @@ def desc_directive(desctype, arguments, options, content, lineno, state.document.note_explicit_target(signode) inode['entries'].append( ('pair', _('%scommand line option; %s') % - ((env.currprogram and env.currprogram + ' ' or ''), sig), + ((env.currprogram and env.currprogram + ' ' or ''), + sig), targetname, targetname)) env.note_progoption(optname, targetname) continue @@ -473,7 +477,8 @@ def desc_directive(desctype, arguments, options, content, lineno, continue else: # another registered generic x-ref directive - rolename, indextemplate, parse_node = additional_xref_types[desctype] + rolename, indextemplate, parse_node = \ + additional_xref_types[desctype] if parse_node: fullname = parse_node(env, sig, signode) else: @@ -502,8 +507,8 @@ def desc_directive(desctype, arguments, options, content, lineno, signode.clear() signode += addnodes.desc_name(sig, sig) continue # we don't want an index entry here - # only add target and index entry if this is the first description of the - # function name in this desc block + # only add target and index entry if this is the first description + # of the function name in this desc block if not noindex and name not in names: fullname = (module and module + '.' or '') + name # note target @@ -583,7 +588,7 @@ additional_xref_types = { del _ -# ------ target -------------------------------------------------------------------- +# ------ target ---------------------------------------------------------------- def target_directive(targettype, arguments, options, content, lineno, content_offset, block_text, state, state_machine): @@ -603,7 +608,8 @@ def target_directive(targettype, arguments, options, content, lineno, if colon != -1: indextype = indexentry[:colon].strip() indexentry = indexentry[colon+1:].strip() - inode = addnodes.index(entries=[(indextype, indexentry, targetname, targetname)]) + inode = addnodes.index(entries=[(indextype, indexentry, + targetname, targetname)]) ret.insert(0, inode) env.note_reftarget(rolename, fullname, targetname) return ret @@ -611,5 +617,5 @@ def target_directive(targettype, arguments, options, content, lineno, target_directive.content = 0 target_directive.arguments = (1, 0, 1) -# note, the target directive is not registered here, it is used by the application -# when registering additional xref types +# note, the target directive is not registered here, it is used by the +# application when registering additional xref types diff --git a/sphinx/directives/other.py b/sphinx/directives/other.py index cbf548bec..18e18fd92 100644 --- a/sphinx/directives/other.py +++ b/sphinx/directives/other.py @@ -18,7 +18,7 @@ from sphinx.util import patfilter, ws_re, caption_ref_re, docname_join from sphinx.util.compat import make_admonition -# ------ the TOC tree --------------------------------------------------------------- +# ------ the TOC tree ---------------------------------------------------------- def toctree_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): @@ -50,7 +50,8 @@ def toctree_directive(name, arguments, options, content, lineno, docname = docname_join(env.docname, docname) if docname not in env.found_docs: ret.append(state.document.reporter.warning( - 'toctree references unknown document %r' % docname, line=lineno)) + 'toctree references unknown document %r' % docname, + line=lineno)) else: includefiles.append(docname) else: @@ -61,8 +62,8 @@ def toctree_directive(name, arguments, options, content, lineno, includefiles.append(docname) if not docnames: ret.append(state.document.reporter.warning( - 'toctree glob pattern %r didn\'t match any documents' % entry, - line=lineno)) + 'toctree glob pattern %r didn\'t match any documents' + % entry, line=lineno)) subnode = addnodes.toctree() subnode['includefiles'] = includefiles subnode['includetitles'] = includetitles @@ -78,7 +79,7 @@ toctree_directive.options = {'maxdepth': int, 'glob': directives.flag, directives.register_directive('toctree', toctree_directive) -# ------ section metadata ---------------------------------------------------------- +# ------ section metadata ------------------------------------------------------ def module_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): @@ -101,7 +102,8 @@ def module_directive(name, arguments, options, content, lineno, node += nodes.emphasis('', _('Platforms: ')) node += nodes.Text(options['platform'], options['platform']) ret.append(node) - # the synopsis isn't printed; in fact, it is only used in the modindex currently + # the synopsis isn't printed; in fact, it is only used in the + # modindex currently if not noindex: indextext = _('%s (module)') % modname inode = addnodes.index(entries=[('single', indextext, @@ -172,7 +174,7 @@ program_directive.arguments = (1, 0, 1) directives.register_directive('program', program_directive) -# ------ index markup -------------------------------------------------------------- +# ------ index markup ---------------------------------------------------------- indextypes = [ 'single', 'pair', 'triple', @@ -214,7 +216,7 @@ def index_directive(name, arguments, options, content, lineno, index_directive.arguments = (1, 0, 1) directives.register_directive('index', index_directive) -# ------ versionadded/versionchanged ----------------------------------------------- +# ------ versionadded/versionchanged ------------------------------------------- def version_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): @@ -241,7 +243,7 @@ directives.register_directive('versionadded', version_directive) directives.register_directive('versionchanged', version_directive) -# ------ see also ------------------------------------------------------------------ +# ------ see also -------------------------------------------------------------- def seealso_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): @@ -261,7 +263,7 @@ seealso_directive.arguments = (0, 1, 1) directives.register_directive('seealso', seealso_directive) -# ------ production list (for the reference) --------------------------------------- +# ------ production list (for the reference) ----------------------------------- token_re = re.compile('`([a-z_]+)`') @@ -317,7 +319,7 @@ productionlist_directive.arguments = (1, 0, 1) directives.register_directive('productionlist', productionlist_directive) -# ------ glossary directive --------------------------------------------------------- +# ------ glossary directive ---------------------------------------------------- def glossary_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): @@ -354,7 +356,7 @@ glossary_directive.arguments = (0, 0, 0) directives.register_directive('glossary', glossary_directive) -# ------ miscellaneous markup ------------------------------------------------------- +# ------ miscellaneous markup -------------------------------------------------- def centered_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): @@ -373,7 +375,8 @@ def acks_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine): node = addnodes.acks() state.nested_parse(content, content_offset, node) - if len(node.children) != 1 or not isinstance(node.children[0], nodes.bullet_list): + if len(node.children) != 1 or not isinstance(node.children[0], + nodes.bullet_list): return [state.document.reporter.warning('.. acks content is not a list', line=lineno)] return [node] @@ -388,9 +391,10 @@ def hlist_directive(name, arguments, options, content, lineno, ncolumns = options.get('columns', 2) node = nodes.paragraph() state.nested_parse(content, content_offset, node) - if len(node.children) != 1 or not isinstance(node.children[0], nodes.bullet_list): - return [state.document.reporter.warning('.. hlist content is not a list', - line=lineno)] + if len(node.children) != 1 or not isinstance(node.children[0], + nodes.bullet_list): + return [state.document.reporter.warning( + '.. hlist content is not a list', line=lineno)] fulllist = node.children[0] # create a hlist node where the items are distributed npercol, nmore = divmod(len(fulllist), ncolumns) diff --git a/sphinx/environment.py b/sphinx/environment.py index fe4cba6bb..d28043326 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -205,8 +205,8 @@ class BuildEnvironment: self.set_warnfunc(None) values = self.config.values del self.config.values - # first write to a temporary file, so that if dumping fails, the existing - # environment won't be overwritten + # first write to a temporary file, so that if dumping fails, + # the existing environment won't be overwritten picklefile = open(filename + '.tmp', 'wb') # remove potentially pickling-problematic values from config for key, val in vars(self.config).items(): @@ -244,13 +244,14 @@ class BuildEnvironment: # this is to invalidate old pickles self.version = ENV_VERSION - # All "docnames" here are /-separated and relative and exclude the source suffix. + # All "docnames" here are /-separated and relative and exclude + # the source suffix. self.found_docs = set() # contains all existing docnames self.all_docs = {} # docname -> mtime at the time of build # contains all built docnames - self.dependencies = {} # docname -> set of dependent file names, relative to - # documentation root + self.dependencies = {} # docname -> set of dependent file + # names, relative to documentation root # File metadata self.metadata = {} # docname -> dict of metadata items @@ -259,30 +260,34 @@ class BuildEnvironment: self.titles = {} # docname -> title node self.tocs = {} # docname -> table of contents nodetree self.toc_num_entries = {} # docname -> number of real entries - # used to determine when to show the TOC in a sidebar - # (don't show if it's only one item) + # used to determine when to show the TOC + # in a sidebar (don't show if it's only one item) + self.toctree_includes = {} # docname -> list of toctree includefiles - self.files_to_rebuild = {} # docname -> set of files (containing its TOCs) - # to rebuild too + self.files_to_rebuild = {} # docname -> set of files + # (containing its TOCs) to rebuild too self.glob_toctrees = set() # docnames that have :glob: toctrees # X-ref target inventory self.descrefs = {} # fullname -> docname, desctype self.filemodules = {} # docname -> [modules] - self.modules = {} # modname -> docname, synopsis, platform, deprecated + self.modules = {} # modname -> docname, synopsis, + # platform, deprecated self.labels = {} # labelname -> docname, labelid, sectionname self.anonlabels = {} # labelname -> docname, labelid self.progoptions = {} # (program, name) -> docname, labelid self.reftargets = {} # (type, name) -> docname, labelid - # where type is term, token, envvar, citation + # type: term, token, envvar, citation # Other inventories self.indexentries = {} # docname -> list of # (type, string, target, aliasname) - self.versionchanges = {} # version -> list of - # (type, docname, lineno, module, descname, content) - self.images = FilenameUniqDict() # absolute path -> (docnames, unique filename) - self.dlfiles = FilenameUniqDict() # absolute path -> (docnames, unique filename) + self.versionchanges = {} # version -> list of (type, docname, + # lineno, module, descname, content) + + # these map absolute path -> (docnames, unique filename) + self.images = FilenameUniqDict() + self.dlfiles = FilenameUniqDict() # These are set while parsing a file self.docname = None # current document name @@ -362,7 +367,8 @@ class BuildEnvironment: """ suffix = suffix or self.config.source_suffix if base is True: - return path.join(self.srcdir, docname.replace(SEP, path.sep)) + suffix + return path.join(self.srcdir, + docname.replace(SEP, path.sep)) + suffix elif base is None: return docname.replace(SEP, path.sep) + suffix else: @@ -375,8 +381,10 @@ class BuildEnvironment: exclude_dirs = [d.replace(SEP, path.sep) for d in config.exclude_dirs] exclude_trees = [d.replace(SEP, path.sep) for d in config.exclude_trees] self.found_docs = set(get_matching_docs( - self.srcdir, config.source_suffix, exclude_docs=set(config.unused_docs), - exclude_dirs=exclude_dirs, exclude_trees=exclude_trees, + self.srcdir, config.source_suffix, + exclude_docs=set(config.unused_docs), + exclude_dirs=exclude_dirs, + exclude_trees=exclude_trees, exclude_dirnames=['_sources'] + config.exclude_dirnames)) def get_outdated_files(self, config_changed): @@ -428,16 +436,17 @@ class BuildEnvironment: return added, changed, removed def update(self, config, srcdir, doctreedir, app=None): - """(Re-)read all files new or changed since last update. Yields a summary - and then docnames as it processes them. Store all environment docnames - in the canonical format (ie using SEP as a separator in place of - os.path.sep).""" + """(Re-)read all files new or changed since last update. + Yields a summary and then docnames as it processes them. + Store all environment docnames in the canonical format + (ie using SEP as a separator in place of os.path.sep).""" config_changed = False if self.config is None: msg = '[new config] ' config_changed = True else: - # check if a config value was changed that affects how doctrees are read + # check if a config value was changed that affects how + # doctrees are read for key, descr in config.config_values.iteritems(): if not descr[1]: continue @@ -577,7 +586,8 @@ class BuildEnvironment: if save_parsed: # save the parsed doctree - doctree_filename = self.doc2path(docname, self.doctreedir, '.doctree') + doctree_filename = self.doc2path(docname, self.doctreedir, + '.doctree') dirname = path.dirname(doctree_filename) if not path.isdir(dirname): os.makedirs(dirname) @@ -638,7 +648,8 @@ class BuildEnvironment: node['candidates'] = candidates = {} imguri = node['uri'] if imguri.find('://') != -1: - self.warn(docname, 'Nonlocal image URI found: %s' % imguri, node.line) + self.warn(docname, 'Nonlocal image URI found: %s' % imguri, + node.line) candidates['?'] = imguri continue # imgpath is the image path *from srcdir* @@ -660,7 +671,8 @@ class BuildEnvironment: finally: f.close() except (OSError, IOError): - self.warn(docname, 'Image file %s not readable' % filename) + self.warn(docname, + 'Image file %s not readable' % filename) if imgtype: candidates['image/' + imgtype] = new_imgpath else: @@ -725,7 +737,8 @@ class BuildEnvironment: continue if name in self.labels: self.warn(docname, 'duplicate label %s, ' % name + - 'other instance in %s' % self.doc2path(self.labels[name][0]), + 'other instance in ' + + self.doc2path(self.labels[name][0]), node.line) self.anonlabels[name] = docname, labelid if node.tagname == 'section': @@ -835,7 +848,8 @@ class BuildEnvironment: if fullname in self.descrefs: self.warn(self.docname, 'duplicate canonical description name %s, ' % fullname + - 'other instance in %s' % self.doc2path(self.descrefs[fullname][0]), + 'other instance in ' + + self.doc2path(self.descrefs[fullname][0]), line) self.descrefs[fullname] = (self.docname, desctype) @@ -851,7 +865,8 @@ class BuildEnvironment: def note_versionchange(self, type, version, node, lineno): self.versionchanges.setdefault(version, []).append( - (type, self.docname, lineno, self.currmodule, self.currdesc, node.astext())) + (type, self.docname, lineno, self.currmodule, self.currdesc, + node.astext())) def note_dependency(self, filename): basename = path.dirname(self.doc2path(self.docname, base=None)) @@ -915,7 +930,8 @@ class BuildEnvironment: def _walk_depth(node, depth, maxdepth, titleoverrides): """Utility: Cut a TOC at a specified depth.""" for subnode in node.children[:]: - if isinstance(subnode, (addnodes.compact_paragraph, nodes.list_item)): + if isinstance(subnode, (addnodes.compact_paragraph, + nodes.list_item)): subnode['classes'].append('toctree-l%d' % (depth-1)) _walk_depth(subnode, depth, maxdepth, titleoverrides) elif isinstance(subnode, nodes.bullet_list): @@ -934,27 +950,30 @@ class BuildEnvironment: toc = self.tocs[includefile].deepcopy() if not toc.children: # empty toc means: no titles will show up in the toctree - self.warn(docname, 'toctree contains reference to document ' - '%r that doesn\'t have a title: no link will be ' - 'generated' % includefile) + self.warn(docname, + 'toctree contains reference to document ' + '%r that doesn\'t have a title: no link ' + 'will be generated' % includefile) except KeyError: # this is raised if the included file does not exist - self.warn(docname, 'toctree contains reference to nonexisting ' - 'document %r' % includefile) + self.warn(docname, 'toctree contains reference to ' + 'nonexisting document %r' % includefile) else: # if titles_only is given, only keep the main title and # sub-toctrees if titles_only: - # delete everything but the toplevel title(s) and toctrees + # delete everything but the toplevel title(s) + # and toctrees for toplevel in toc: # nodes with length 1 don't have any children anyway if len(toplevel) > 1: - subtoctrees = toplevel.traverse(addnodes.toctree) - toplevel[1][:] = subtoctrees + subtrees = toplevel.traverse(addnodes.toctree) + toplevel[1][:] = subtrees # resolve all sub-toctrees for toctreenode in toc.traverse(addnodes.toctree): i = toctreenode.parent.index(toctreenode) + 1 - for item in _entries_from_toctree(toctreenode, subtree=True): + for item in _entries_from_toctree(toctreenode, + subtree=True): toctreenode.parent.insert(i, item) i += 1 toctreenode.parent.remove(toctreenode) @@ -993,8 +1012,9 @@ class BuildEnvironment: refnode.children = [nodes.Text(newtitle)] return newnode - descroles = frozenset(('data', 'exc', 'func', 'class', 'const', 'attr', 'obj', - 'meth', 'cfunc', 'cmember', 'cdata', 'ctype', 'cmacro')) + descroles = frozenset(('data', 'exc', 'func', 'class', 'const', + 'attr', 'obj', 'meth', 'cfunc', 'cmember', + 'cdata', 'ctype', 'cmacro')) def resolve_references(self, doctree, fromdocname, builder): reftarget_roles = set(('token', 'term', 'citation')) @@ -1011,30 +1031,32 @@ class BuildEnvironment: try: if typ == 'ref': if node['refcaption']: - # reference to anonymous label; the reference uses the supplied - # link caption + # reference to anonymous label; the reference uses + # the supplied link caption docname, labelid = self.anonlabels.get(target, ('','')) sectname = node.astext() if not docname: newnode = doctree.reporter.system_message( 2, 'undefined label: %s' % target) else: - # reference to the named label; the final node will contain the - # section name after the label - docname, labelid, sectname = self.labels.get(target, ('','','')) + # reference to the named label; the final node will + # contain the section name after the label + docname, labelid, sectname = self.labels.get(target, + ('','','')) if not docname: newnode = doctree.reporter.system_message( - 2, 'undefined label: %s -- if you don\'t ' % target + - 'give a link caption the label must precede a section ' - 'header.') + 2, 'undefined label: %s' % target + + ' -- if you don\'t give a link caption ' + 'the label must precede a section header.') if docname: newnode = nodes.reference('', '') innernode = nodes.emphasis(sectname, sectname) if docname == fromdocname: newnode['refid'] = labelid else: - # set more info in contnode in case the get_relative_uri call - # raises NoUri, the builder will then have to resolve these + # set more info in contnode; in case the + # get_relative_uri call raises NoUri, + # the builder will then have to resolve these contnode = addnodes.pending_xref('') contnode['refdocname'] = docname contnode['refsectname'] = sectname @@ -1044,8 +1066,8 @@ class BuildEnvironment: newnode['refuri'] += '#' + labelid newnode.append(innernode) elif typ == 'doc': - # directly reference to document by source name; can be absolute - # or relative + # directly reference to document by source name; + # can be absolute or relative docname = docname_join(fromdocname, target) if docname not in self.all_docs: newnode = doctree.reporter.system_message( @@ -1077,7 +1099,8 @@ class BuildEnvironment: newnode.append(contnode) elif typ == 'option': progname = node['refprogram'] - docname, labelid = self.progoptions.get((progname, target), ('', '')) + docname, labelid = self.progoptions.get((progname, target), + ('', '')) if not docname: newnode = contnode else: @@ -1089,13 +1112,16 @@ class BuildEnvironment: fromdocname, docname) + '#' + labelid newnode.append(contnode) elif typ in reftarget_roles: - docname, labelid = self.reftargets.get((typ, target), ('', '')) + docname, labelid = self.reftargets.get((typ, target), + ('', '')) if not docname: if typ == 'term': - self.warn(fromdocname, 'term not in glossary: %s' % target, + self.warn(fromdocname, + 'term not in glossary: %s' % target, node.line) elif typ == 'citation': - self.warn(fromdocname, 'citation not found: %s' % target, + self.warn(fromdocname, + 'citation not found: %s' % target, node.line) newnode = contnode else: @@ -1110,8 +1136,8 @@ class BuildEnvironment: docname, synopsis, platform, deprecated = \ self.modules.get(target, ('','','', '')) if not docname: - newnode = builder.app.emit_firstresult('missing-reference', - self, node, contnode) + newnode = builder.app.emit_firstresult( + 'missing-reference', self, node, contnode) if not newnode: newnode = contnode elif docname == fromdocname: @@ -1133,8 +1159,8 @@ class BuildEnvironment: name, desc = self.find_desc(modname, clsname, target, typ, searchorder) if not desc: - newnode = builder.app.emit_firstresult('missing-reference', - self, node, contnode) + newnode = builder.app.emit_firstresult( + 'missing-reference', self, node, contnode) if not newnode: newnode = contnode else: @@ -1148,7 +1174,8 @@ class BuildEnvironment: newnode['reftitle'] = name newnode.append(contnode) else: - raise RuntimeError('unknown xfileref node encountered: %s' % node) + raise RuntimeError('unknown xfileref node encountered: %s' + % node) except NoUri: newnode = contnode if newnode: @@ -1232,8 +1259,10 @@ class BuildEnvironment: m = _fixre.match(key) if m: if oldkey == m.group(1): - # prefixes match: add entry as subitem of the previous entry - oldsubitems.setdefault(m.group(2), [[], {}])[0].extend(targets) + # prefixes match: add entry as subitem of the + # previous entry + oldsubitems.setdefault(m.group(2), [[], {}])[0].\ + extend(targets) del newlist[i] continue oldkey = m.group(1) @@ -1253,7 +1282,8 @@ class BuildEnvironment: else: # get all other symbols under one heading return 'Symbols' - return [(key, list(group)) for (key, group) in groupby(newlist, keyfunc)] + return [(key, list(group)) + for (key, group) in groupby(newlist, keyfunc)] def collect_relations(self): relations = {} @@ -1292,7 +1322,8 @@ class BuildEnvironment: # else it will stay None # same for children if includes: - for subindex, args in enumerate(izip(includes, [None] + includes, + for subindex, args in enumerate(izip(includes, + [None] + includes, includes[1:] + [None])): collect([(docname, subindex)] + parents, *args) relations[docname] = [parents[0][0], previous, next] @@ -1360,14 +1391,16 @@ class BuildEnvironment: def find_keyword(self, keyword, avoid_fuzzy=False, cutoff=0.6, n=20): """ - Find keyword matches for a keyword. If there's an exact match, just return - it, else return a list of fuzzy matches if avoid_fuzzy isn't True. + Find keyword matches for a keyword. If there's an exact match, + just return it, else return a list of fuzzy matches if avoid_fuzzy + isn't True. Keywords searched are: first modules, then descrefs. Returns: None if nothing found (type, docname, anchorname) if exact match found - list of (quality, type, docname, anchorname, description) if fuzzy + list of (quality, type, docname, anchorname, description) + if fuzzy """ if keyword in self.modules: diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py index d0512f2be..c005e36a9 100644 --- a/sphinx/ext/autodoc.py +++ b/sphinx/ext/autodoc.py @@ -54,7 +54,7 @@ def get_method_type(obj): (isinstance(obj, MethodType) and obj.im_self is not None): return 'classmethod' elif isinstance(obj, FunctionType) or \ - (isinstance(obj, BuiltinFunctionType) and obj.__self__ is not None): + (isinstance(obj, BuiltinFunctionType) and obj.__self__ is not None): return 'staticmethod' else: return 'method' @@ -193,7 +193,8 @@ class RstGenerator(object): docstrings.append(obj.__doc__) # skip some lines in module docstrings if configured (deprecated!) - if what == 'module' and self.env.config.automodule_skip_lines and docstrings: + if what == 'module' and self.env.config.automodule_skip_lines \ + and docstrings: docstrings[0] = '\n'.join(docstrings[0].splitlines() [self.env.config.automodule_skip_lines:]) @@ -212,7 +213,8 @@ class RstGenerator(object): docstrings.append(initdocstring) # the default is only the class docstring - # make sure we have Unicode docstrings, then sanitize and split into lines + # make sure we have Unicode docstrings, then sanitize and split + # into lines return [prepare_docstring(force_decode(docstring, encoding)) for docstring in docstrings] @@ -233,8 +235,9 @@ class RstGenerator(object): Returns a tuple of: the full name, the module name, a path of names to get via getattr, the signature and return annotation. """ - # first, parse the definition -- auto directives for classes and functions - # can contain a signature which is then used instead of an autogenerated one + # first, parse the definition -- auto directives for classes and + # functions can contain a signature which is then used instead of + # an autogenerated one try: mod, path, base, args, retann = py_ext_sig_re.match(name).groups() except: @@ -261,8 +264,8 @@ class RstGenerator(object): if path: mod = path.rstrip('.') else: - # if documenting a toplevel object without explicit module, it can - # be contained in another auto directive ... + # if documenting a toplevel object without explicit module, + # it can be contained in another auto directive ... if hasattr(self.env, 'autodoc_current_module'): mod = self.env.autodoc_current_module # ... or in the scope of a module directive @@ -276,8 +279,9 @@ class RstGenerator(object): mod_cls = path.rstrip('.') else: mod_cls = None - # if documenting a class-level object without path, there must be a - # current class, either from a parent auto directive ... + # if documenting a class-level object without path, + # there must be a current class, either from a parent + # auto directive ... if hasattr(self.env, 'autodoc_current_class'): mod_cls = self.env.autodoc_current_class # ... or from a class directive @@ -313,7 +317,8 @@ class RstGenerator(object): args = None getargs = True if what == 'class': - # for classes, the relevant signature is the __init__ method's + # for classes, the relevant signature is the + # __init__ method's obj = getattr(obj, '__init__', None) # classes without __init__ method, default __init__ or # __init__ written in C? @@ -334,8 +339,9 @@ class RstGenerator(object): args = None err = e - result = self.env.app.emit_firstresult('autodoc-process-signature', what, - name, obj, self.options, args, retann) + result = self.env.app.emit_firstresult( + 'autodoc-process-signature', what, name, obj, + self.options, args, retann) if result: args, retann = result @@ -347,22 +353,24 @@ class RstGenerator(object): else: return '' - def generate(self, what, name, members, add_content, indent=u'', check_module=False, - no_docstring=False): + def generate(self, what, name, members, add_content, indent=u'', + check_module=False, no_docstring=False): """ Generate reST for the object in self.result. """ mod, objpath, args, retann = self.resolve_name(what, name) if not mod: # need a module to import - self.warn('don\'t know which module to import for autodocumenting %r ' - '(try placing a "module" or "currentmodule" directive in the ' - 'document, or giving an explicit module name)' % name) + self.warn('don\'t know which module to import for autodocumenting ' + '%r (try placing a "module" or "currentmodule" directive ' + 'in the document, or giving an explicit module name)' + % name) return # fully-qualified name fullname = mod + (objpath and '.' + '.'.join(objpath) or '') - # the name to put into the generated directive -- doesn't contain the module + # the name to put into the generated directive -- doesn't contain + # the module name_in_directive = '.'.join(objpath) or mod # now, import the module and get object to document @@ -372,8 +380,8 @@ class RstGenerator(object): for part in objpath: todoc = getattr(todoc, part) except (ImportError, AttributeError), err: - self.warn('autodoc can\'t import/find %s %r, it reported error: "%s", ' - 'please check your spelling and sys.path' % + self.warn('autodoc can\'t import/find %s %r, it reported error: ' + '"%s", please check your spelling and sys.path' % (what, str(fullname), err)) return @@ -388,7 +396,7 @@ class RstGenerator(object): else: self.filename_set.add(analyzer.srcname) - # check __module__ of object if wanted (for members not given explicitly) + # check __module__ of object for members not given explicitly if check_module: if hasattr(todoc, '__module__'): if todoc.__module__ != mod: @@ -417,16 +425,16 @@ class RstGenerator(object): if what == 'module': # Add some module-specific options if self.options.synopsis: - self.result.append(indent + u' :synopsis: ' + self.options.synopsis, - '<autodoc>') + self.result.append(indent + u' :synopsis: ' + + self.options.synopsis, '<autodoc>') if self.options.platform: - self.result.append(indent + u' :platform: ' + self.options.platform, - '<autodoc>') + self.result.append(indent + u' :platform: ' + + self.options.platform, '<autodoc>') if self.options.deprecated: self.result.append(indent + u' :deprecated:', '<autodoc>') else: - # Be explicit about the module, this is necessary since .. class:: doesn't - # support a prepended module name + # Be explicit about the module, this is necessary since .. class:: + # doesn't support a prepended module name self.result.append(indent + u' :module: %s' % mod, '<autodoc>') if self.options.noindex: self.result.append(indent + u' :noindex:', '<autodoc>') @@ -439,7 +447,8 @@ class RstGenerator(object): u':class:`%s`' % b.__name__ or u':class:`%s.%s`' % (b.__module__, b.__name__) for b in todoc.__bases__] - self.result.append(indent + _(u' Bases: %s') % ', '.join(bases), + self.result.append(indent + _(u' Bases: %s') % + ', '.join(bases), '<autodoc>') self.result.append(u'', '<autodoc>') @@ -513,7 +522,8 @@ class RstGenerator(object): # base classes all_members = inspect.getmembers(todoc) else: - # __dict__ contains only the members directly defined in the class + # __dict__ contains only the members directly defined + # in the class all_members = sorted(todoc.__dict__.iteritems()) else: all_members = [(mname, getattr(todoc, mname)) for mname in members] @@ -524,7 +534,8 @@ class RstGenerator(object): for (membername, member) in all_members: # if isattr is True, the member is documented as an attribute isattr = False - # if content is not None, no extra content from docstrings will be added + # if content is not None, no extra content from docstrings + # will be added content = None if want_all_members and membername.startswith('_'): @@ -536,15 +547,18 @@ class RstGenerator(object): skip = False isattr = True else: - # ignore undocumented members if :undoc-members: is not given + # ignore undocumented members if :undoc-members: + # is not given doc = getattr(member, '__doc__', None) skip = not self.options.undoc_members and not doc - # give the user a chance to decide whether this member should be skipped + # give the user a chance to decide whether this member + # should be skipped if self.env.app: # let extensions preprocess docstrings skip_user = self.env.app.emit_firstresult( - 'autodoc-skip-member', what, membername, member, skip, self.options) + 'autodoc-skip-member', what, membername, member, + skip, self.options) if skip_user is not None: skip = skip_user if skip: @@ -560,8 +574,9 @@ class RstGenerator(object): if member.__name__ != membername: # assume it's aliased memberwhat = 'data' - content = ViewList([_('alias of :class:`%s`') % member.__name__], - source='') + content = ViewList( + [_('alias of :class:`%s`') % member.__name__], + source='') elif issubclass(member, base_exception): memberwhat = 'exception' else: @@ -577,8 +592,9 @@ class RstGenerator(object): if member.__name__ != membername: # assume it's aliased memberwhat = 'attribute' - content = ViewList([_('alias of :class:`%s`') % member.__name__], - source='') + content = ViewList( + [_('alias of :class:`%s`') % member.__name__], + source='') else: memberwhat = 'class' elif isdescriptor(member): @@ -586,8 +602,8 @@ class RstGenerator(object): else: continue - # give explicitly separated module name, so that members of inner classes - # can be documented + # give explicitly separated module name, so that members + # of inner classes can be documented full_membername = mod + '::' + '.'.join(objpath + [membername]) self.generate(memberwhat, full_membername, ['__all__'], add_content=content, no_docstring=bool(content), @@ -653,13 +669,17 @@ def members_option(arg): def setup(app): - mod_options = {'members': members_option, 'undoc-members': directives.flag, - 'noindex': directives.flag, 'inherited-members': directives.flag, - 'show-inheritance': directives.flag, 'synopsis': lambda x: x, - 'platform': lambda x: x, 'deprecated': directives.flag} - cls_options = {'members': members_option, 'undoc-members': directives.flag, - 'noindex': directives.flag, 'inherited-members': directives.flag, - 'show-inheritance': directives.flag} + mod_options = { + 'members': members_option, 'undoc-members': directives.flag, + 'noindex': directives.flag, 'inherited-members': directives.flag, + 'show-inheritance': directives.flag, 'synopsis': lambda x: x, + 'platform': lambda x: x, 'deprecated': directives.flag + } + cls_options = { + 'members': members_option, 'undoc-members': directives.flag, + 'noindex': directives.flag, 'inherited-members': directives.flag, + 'show-inheritance': directives.flag + } app.add_directive('automodule', automodule_directive, 1, (1, 0, 1), **mod_options) app.add_directive('autoclass', autoclass_directive, diff --git a/sphinx/ext/coverage.py b/sphinx/ext/coverage.py index a3dc58897..964e58eec 100644 --- a/sphinx/ext/coverage.py +++ b/sphinx/ext/coverage.py @@ -53,17 +53,17 @@ class CoverageBuilder(Builder): self.c_ignorexps = {} for (name, exps) in self.config.coverage_ignore_c_items.iteritems(): - self.c_ignorexps[name] = compile_regex_list('coverage_ignore_c_items', - exps, self.warn) - self.mod_ignorexps = compile_regex_list('coverage_ignore_modules', - self.config.coverage_ignore_modules, - self.warn) - self.cls_ignorexps = compile_regex_list('coverage_ignore_classes', - self.config.coverage_ignore_classes, - self.warn) - self.fun_ignorexps = compile_regex_list('coverage_ignore_functions', - self.config.coverage_ignore_functions, - self.warn) + self.c_ignorexps[name] = compile_regex_list( + 'coverage_ignore_c_items', exps, self.warn) + self.mod_ignorexps = compile_regex_list( + 'coverage_ignore_modules', self.config.coverage_ignore_modules, + self.warn) + self.cls_ignorexps = compile_regex_list( + 'coverage_ignore_classes', self.config.coverage_ignore_classes, + self.warn) + self.fun_ignorexps = compile_regex_list( + 'coverage_ignore_functions', self.config.coverage_ignore_functions, + self.warn) def get_outdated_docs(self): return 'coverage overview' @@ -128,7 +128,8 @@ class CoverageBuilder(Builder): try: mod = __import__(mod_name, fromlist=['foo']) except ImportError, err: - self.warn('module %s could not be imported: %s' % (mod_name, err)) + self.warn('module %s could not be imported: %s' % + (mod_name, err)) self.py_undoc[mod_name] = {'error': err} continue @@ -168,7 +169,8 @@ class CoverageBuilder(Builder): attrs = [] - for attr_name, attr in inspect.getmembers(obj, inspect.ismethod): + for attr_name, attr in inspect.getmembers( + obj, inspect.ismethod): if attr_name[0] == '_': # starts with an underscore, ignore it continue diff --git a/sphinx/ext/doctest.py b/sphinx/ext/doctest.py index d6697f989..d2aacaa45 100644 --- a/sphinx/ext/doctest.py +++ b/sphinx/ext/doctest.py @@ -262,13 +262,15 @@ Doctest summary for group in groups.itervalues(): group.add_code(code) if self.config.doctest_global_setup: - code = TestCode(self.config.doctest_global_setup, 'testsetup', lineno=0) + code = TestCode(self.config.doctest_global_setup, + 'testsetup', lineno=0) for group in groups.itervalues(): group.add_code(code, prepend=True) if not groups: return - self._out('\nDocument: %s\n----------%s\n' % (docname, '-'*len(docname))) + self._out('\nDocument: %s\n----------%s\n' % + (docname, '-'*len(docname))) for group in groups.itervalues(): self.test_group(group, self.env.doc2path(docname, base=None)) # Separately count results from setup code @@ -287,7 +289,8 @@ Doctest summary ns = {} examples = [] for setup in group.setup: - examples.append(doctest.Example(setup.code, '', lineno=setup.lineno)) + examples.append(doctest.Example(setup.code, '', + lineno=setup.lineno)) if examples: # simulate a doctest with the setup code setup_doctest = doctest.DocTest(examples, {}, diff --git a/sphinx/ext/ifconfig.py b/sphinx/ext/ifconfig.py index f622ec49c..af3975b83 100644 --- a/sphinx/ext/ifconfig.py +++ b/sphinx/ext/ifconfig.py @@ -13,8 +13,8 @@ This stuff is only included in the built docs for unstable versions. The argument for ``ifconfig`` is a plain Python expression, evaluated in the - namespace of the project configuration (that is, all variables from ``conf.py`` - are available.) + namespace of the project configuration (that is, all variables from + ``conf.py`` are available.) :copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. diff --git a/sphinx/ext/jsmath.py b/sphinx/ext/jsmath.py index 1bea33044..e51af4550 100644 --- a/sphinx/ext/jsmath.py +++ b/sphinx/ext/jsmath.py @@ -32,7 +32,8 @@ def html_visit_displaymath(self, node): if i == 0: # necessary to e.g. set the id property correctly if node['number']: - self.body.append('<span class="eqno">(%s)</span>' % node['number']) + self.body.append('<span class="eqno">(%s)</span>' % + node['number']) self.body.append(self.starttag(node, 'div', CLASS='math')) else: # but only once! diff --git a/sphinx/ext/pngmath.py b/sphinx/ext/pngmath.py index dc1d2ee8d..61df53a56 100644 --- a/sphinx/ext/pngmath.py +++ b/sphinx/ext/pngmath.py @@ -117,9 +117,9 @@ def render_math(self, math): if err.errno != 2: # No such file or directory raise if not hasattr(self.builder, '_mathpng_warned_latex'): - self.builder.warn('LaTeX command %r cannot be run (needed for math ' - 'display), check the pngmath_latex setting' % - self.builder.config.pngmath_latex) + self.builder.warn('LaTeX command %r cannot be run (needed for ' + 'math display), check the pngmath_latex ' + 'setting' % self.builder.config.pngmath_latex) self.builder._mathpng_warned_latex = True return relfn, None finally: @@ -127,8 +127,8 @@ def render_math(self, math): stdout, stderr = p.communicate() if p.returncode != 0: - raise MathExtError('latex exited with error:\n[stderr]\n%s\n[stdout]\n%s' - % (stderr, stdout)) + raise MathExtError('latex exited with error:\n[stderr]\n%s\n' + '[stdout]\n%s' % (stderr, stdout)) ensuredir(path.dirname(outfn)) # use some standard dvipng arguments @@ -146,15 +146,15 @@ def render_math(self, math): if err.errno != 2: # No such file or directory raise if not hasattr(self.builder, '_mathpng_warned_dvipng'): - self.builder.warn('dvipng command %r cannot be run (needed for math ' - 'display), check the pngmath_dvipng setting' % - self.builder.config.pngmath_dvipng) + self.builder.warn('dvipng command %r cannot be run (needed for ' + 'math display), check the pngmath_dvipng setting' + % self.builder.config.pngmath_dvipng) self.builder._mathpng_warned_dvipng = True return relfn, None stdout, stderr = p.communicate() if p.returncode != 0: - raise MathExtError('dvipng exited with error:\n[stderr]\n%s\n[stdout]\n%s' - % (stderr, stdout)) + raise MathExtError('dvipng exited with error:\n[stderr]\n%s\n' + '[stdout]\n%s' % (stderr, stdout)) depth = None if use_preview: for line in stdout.splitlines(): @@ -187,7 +187,8 @@ def html_visit_math(self, node): raise nodes.SkipNode self.body.append('<img class="math" src="%s" alt="%s" %s/>' % (fname, self.encode(node['latex']).strip(), - depth and 'style="vertical-align: %dpx" ' % (-depth) or '')) + depth and 'style="vertical-align: %dpx" ' % + (-depth) or '')) raise nodes.SkipNode def html_visit_displaymath(self, node): diff --git a/sphinx/ext/refcounting.py b/sphinx/ext/refcounting.py index c31d66270..cad9d7f1a 100644 --- a/sphinx/ext/refcounting.py +++ b/sphinx/ext/refcounting.py @@ -55,7 +55,8 @@ class Refcounts(dict): refcount = None else: refcount = int(refcount) - # Update the entry with the new parameter or the result information. + # Update the entry with the new parameter or the result + # information. if arg: entry.args.append((arg, type, refcount)) else: @@ -81,7 +82,8 @@ class Refcounts(dict): if entry.result_refs is None: rc += "Always NULL." else: - rc += (entry.result_refs and "New" or "Borrowed") + " reference." + rc += (entry.result_refs and "New" or "Borrowed") + \ + " reference." node.insert(0, refcount(rc, rc)) diff --git a/sphinx/ext/todo.py b/sphinx/ext/todo.py index dac906604..b7a8d5007 100644 --- a/sphinx/ext/todo.py +++ b/sphinx/ext/todo.py @@ -72,8 +72,8 @@ def process_todo_nodes(app, doctree, fromdocname): para = nodes.paragraph() filename = env.doc2path(todo_info['docname'], base=None) description = ( - _('(The original entry is located in %s, line %d and can be found ') % - (filename, todo_info['lineno'])) + _('(The original entry is located in %s, line %d and ' + 'can be found ') % (filename, todo_info['lineno'])) para += nodes.Text(description, description) # Create a reference diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index 61cea214d..61c413d7a 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -101,7 +101,8 @@ class PygmentsBridge(object): style = NoneStyle elif '.' in stylename: module, stylename = stylename.rsplit('.', 1) - style = getattr(__import__(module, None, None, ['__name__']), stylename) + style = getattr(__import__(module, None, None, ['__name__']), + stylename) else: style = get_style_by_name(stylename) if dest == 'html': diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py index c2086da58..d195d6c3a 100644 --- a/sphinx/pycode/__init__.py +++ b/sphinx/pycode/__init__.py @@ -91,7 +91,8 @@ class AttrDocVisitor(nodes.NodeVisitor): return if prev.type == sym.simple_stmt and \ prev[0].type == sym.expr_stmt and _eq in prev[0].children: - # need to "eval" the string because it's returned in its original form + # need to "eval" the string because it's returned in its + # original form docstring = literals.evalString(node[0].value, self.encoding) docstring = prepare_docstring(docstring) self.add_docstring(prev[0], docstring) @@ -159,7 +160,8 @@ class ModuleAnalyzer(object): try: source = mod.__loader__.get_source(modname) except Exception, err: - raise PycodeError('error getting source for %r' % modname, err) + raise PycodeError('error getting source for %r' % modname, + err) obj = cls.for_string(source, modname) cls.cache['module', modname] = obj return obj @@ -279,8 +281,9 @@ class ModuleAnalyzer(object): namespace.pop() result[fullname] = (dtype, startline, endline) elif type == token.NEWLINE: - # if this line contained a definition, expect an INDENT to start the - # suite; if there is no such INDENT it's a one-line definition + # if this line contained a definition, expect an INDENT + # to start the suite; if there is no such INDENT + # it's a one-line definition if defline: defline = False expect_indent = True @@ -292,7 +295,8 @@ if __name__ == '__main__': import time, pprint x0 = time.time() #ma = ModuleAnalyzer.for_file(__file__.rstrip('c'), 'sphinx.builders.html') - ma = ModuleAnalyzer.for_file('sphinx/builders/html.py', 'sphinx.builders.html') + ma = ModuleAnalyzer.for_file('sphinx/builders/html.py', + 'sphinx.builders.html') ma.tokenize() x1 = time.time() ma.parse() diff --git a/sphinx/pycode/nodes.py b/sphinx/pycode/nodes.py index 4d27fc660..efdf8f061 100644 --- a/sphinx/pycode/nodes.py +++ b/sphinx/pycode/nodes.py @@ -102,7 +102,8 @@ class Node(BaseNode): ch.parent = self def __repr__(self): - return '%s(%s, %r)' % (self.__class__.__name__, self.type, self.children) + return '%s(%s, %r)' % (self.__class__.__name__, + self.type, self.children) def __str__(self): """This reproduces the input source exactly.""" @@ -174,7 +175,8 @@ def nice_repr(node, number2name, prefix=False): ', '.join(map(_repr, node.children))) def _prepr(node): if isinstance(node, Leaf): - return "%s(%r, %r)" % (number2name[node.type], node.prefix, node.value) + return "%s(%r, %r)" % (number2name[node.type], + node.prefix, node.value) else: return "%s(%s)" % (number2name[node.type], ', '.join(map(_prepr, node.children))) diff --git a/sphinx/quickstart.py b/sphinx/quickstart.py index 67ab62731..c0a219efa 100644 --- a/sphinx/quickstart.py +++ b/sphinx/quickstart.py @@ -15,7 +15,8 @@ from os import path TERM_ENCODING = getattr(sys.stdin, 'encoding', None) from sphinx.util import make_filename -from sphinx.util.console import purple, bold, red, turquoise, nocolor, color_terminal +from sphinx.util.console import purple, bold, red, turquoise, \ + nocolor, color_terminal from sphinx.util import texescape @@ -29,9 +30,6 @@ QUICKSTART_CONF = '''\ # # This file is execfile()d with the current directory set to its containing dir. # -# The contents of this file are pickled, so don't put values in the namespace -# that aren't pickleable (module imports are okay, they're removed automatically). -# # Note that not all possible configuration values are present in this # autogenerated file. # @@ -45,8 +43,7 @@ import sys, os # absolute, like shown here. #sys.path.append(os.path.abspath('.')) -# General configuration -# --------------------- +# -- General configuration ----------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. @@ -112,8 +109,7 @@ exclude_trees = [%(exclude_trees)s] pygments_style = 'sphinx' -# Options for HTML output -# ----------------------- +# -- Options for HTML output --------------------------------------------------- # The style sheet to use for HTML and HTML Help pages. A file of that name # must exist either in Sphinx' static/ path, or in one of the custom paths @@ -180,8 +176,7 @@ html_static_path = ['%(dot)sstatic'] htmlhelp_basename = '%(project_fn)sdoc' -# Options for LaTeX output -# ------------------------ +# -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' @@ -190,7 +185,7 @@ htmlhelp_basename = '%(project_fn)sdoc' #latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, document class [howto/manual]). +# (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('%(master)s', '%(project_fn)s.tex', ur'%(project_doc_texescaped)s', ur'%(author_texescaped)s', 'manual'), @@ -217,11 +212,12 @@ latex_documents = [ INTERSPHINX_CONFIG = ''' # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'http://docs.python.org/dev': None} +intersphinx_mapping = {'http://docs.python.org/': None} ''' MASTER_FILE = '''\ -.. %(project)s documentation master file, created by sphinx-quickstart on %(now)s. +.. %(project)s documentation master file, created by + sphinx-quickstart on %(now)s. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. @@ -267,7 +263,7 @@ help: \t@echo " htmlhelp to make HTML files and a HTML help project" \t@echo " qthelp to make HTML files and a qthelp project" \t@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" -\t@echo " changes to make an overview over all changed/added/deprecated items" +\t@echo " changes to make an overview of all changed/added/deprecated items" \t@echo " linkcheck to check all external links for integrity" clean: @@ -466,8 +462,9 @@ def do_prompt(d, key, text, default=None, validator=nonempty): if TERM_ENCODING: x = x.decode(TERM_ENCODING) else: - print turquoise('* Note: non-ASCII characters entered and terminal ' - 'encoding unknown -- assuming UTF-8 or Latin-1.') + print turquoise('* Note: non-ASCII characters entered ' + 'and terminal encoding unknown -- assuming ' + 'UTF-8 or Latin-1.') try: x = x.decode('utf-8') except UnicodeDecodeError: @@ -502,8 +499,8 @@ Enter the root path for documentation.''' 'selected root path.') print 'sphinx-quickstart will not overwrite existing Sphinx projects.' print - do_prompt(d, 'path', 'Please enter a new root path (or just Enter to exit)', - '', is_path) + do_prompt(d, 'path', 'Please enter a new root path (or just Enter ' + 'to exit)', '', is_path) if not d['path']: sys.exit(1) @@ -516,8 +513,8 @@ Either, you use a directory "_build" within the root path, or you separate print ''' Inside the root directory, two more directories will be created; "_templates" -for custom HTML templates and "_static" for custom stylesheets and other -static files. You can enter another prefix (such as ".") to replace the underscore.''' +for custom HTML templates and "_static" for custom stylesheets and other static +files. You can enter another prefix (such as ".") to replace the underscore.''' do_prompt(d, 'dot', 'Name prefix for templates and static dir', '_', ok) print ''' @@ -549,26 +546,29 @@ Please indicate if you want to use one of the following Sphinx extensions:''' 'from modules (y/N)', 'n', boolean) do_prompt(d, 'ext_doctest', 'doctest: automatically test code snippets ' 'in doctest blocks (y/N)', 'n', boolean) - do_prompt(d, 'ext_intersphinx', 'intersphinx: link between Sphinx documentation ' - 'of different projects (y/N)', 'n', boolean) + do_prompt(d, 'ext_intersphinx', 'intersphinx: link between Sphinx ' + 'documentation of different projects (y/N)', 'n', boolean) print ''' A Makefile and a Windows command file can be generated for you so that you only have to run e.g. `make html' instead of invoking sphinx-build directly.''' do_prompt(d, 'makefile', 'Create Makefile? (Y/n)', 'y', boolean) - do_prompt(d, 'batchfile', 'Create Windows command file? (Y/n)', 'y', boolean) + do_prompt(d, 'batchfile', 'Create Windows command file? (Y/n)', + 'y', boolean) d['project_fn'] = make_filename(d['project']) d['now'] = time.asctime() d['underline'] = len(d['project']) * '=' d['extensions'] = ', '.join( - repr('sphinx.ext.' + name) for name in ('autodoc', 'doctest', 'intersphinx') + repr('sphinx.ext.' + name) for name in ('autodoc', 'doctest', + 'intersphinx') if d['ext_' + name].upper() in ('Y', 'YES')) d['copyright'] = time.strftime('%Y') + ', ' + d['author'] - d['author_texescaped'] = unicode(d['author']).translate(texescape.tex_escape_map) + d['author_texescaped'] = unicode(d['author']).\ + translate(texescape.tex_escape_map) d['project_doc'] = d['project'] + ' Documentation' - d['project_doc_texescaped'] = \ - unicode(d['project'] + ' Documentation').translate(texescape.tex_escape_map) + d['project_doc_texescaped'] = unicode(d['project'] + ' Documentation').\ + translate(texescape.tex_escape_map) if not path.isdir(d['path']): mkdir_p(d['path']) diff --git a/sphinx/roles.py b/sphinx/roles.py index d2e9558e9..837b5cb80 100644 --- a/sphinx/roles.py +++ b/sphinx/roles.py @@ -36,7 +36,8 @@ for rolename, nodeclass in generic_docroles.iteritems(): roles.register_generic_role(rolename, nodeclass) -def indexmarkup_role(typ, rawtext, etext, lineno, inliner, options={}, content=[]): +def indexmarkup_role(typ, rawtext, etext, lineno, inliner, + options={}, content=[]): env = inliner.document.settings.env if not typ: typ = env.config.default_role @@ -56,13 +57,14 @@ def indexmarkup_role(typ, rawtext, etext, lineno, inliner, options={}, content=[ options, content)[0] return [indexnode, targetnode] + xref_nodes, [] elif typ == 'pep': - indexnode['entries'] = [('single', - _('Python Enhancement Proposals!PEP %s') % text, - targetid, 'PEP %s' % text)] + indexnode['entries'] = [ + ('single', _('Python Enhancement Proposals!PEP %s') % text, + targetid, 'PEP %s' % text)] try: pepnum = int(text) except ValueError: - msg = inliner.reporter.error('invalid PEP number %s' % text, line=lineno) + msg = inliner.reporter.error('invalid PEP number %s' % text, + line=lineno) prb = inliner.problematic(rawtext, rawtext, msg) return [prb], [msg] ref = inliner.document.settings.pep_base_url + 'pep-%04d' % pepnum @@ -76,7 +78,8 @@ def indexmarkup_role(typ, rawtext, etext, lineno, inliner, options={}, content=[ try: rfcnum = int(text) except ValueError: - msg = inliner.reporter.error('invalid RFC number %s' % text, line=lineno) + msg = inliner.reporter.error('invalid RFC number %s' % text, + line=lineno) prb = inliner.problematic(rawtext, rawtext, msg) return [prb], [msg] ref = inliner.document.settings.rfc_base_url + inliner.rfc_url % rfcnum @@ -129,7 +132,8 @@ def xfileref_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): modname=env.currmodule, classname=env.currclass) # we may need the line number for warnings pnode.line = lineno - # the link title may differ from the target, but by default they are the same + # the link title may differ from the target, but by default + # they are the same title = target = text titleistarget = True # look if explicit title and target are given with `foo <bar>` syntax @@ -146,7 +150,8 @@ def xfileref_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): target = text[brace+1:] title = text[:brace] # special target for Python object cross-references - if typ in ('data', 'exc', 'func', 'class', 'const', 'attr', 'meth', 'mod', 'obj'): + if typ in ('data', 'exc', 'func', 'class', 'const', 'attr', + 'meth', 'mod', 'obj'): # fix-up parentheses in link title if titleistarget: title = title.lstrip('.') # only has a meaning for the target @@ -171,7 +176,8 @@ def xfileref_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): elif typ == 'option': program = env.currprogram if titleistarget: - if ' ' in title and not (title.startswith('/') or title.startswith('-')): + if ' ' in title and not (title.startswith('/') or + title.startswith('-')): program, target = re.split(' (?=-|--|/)', title, 1) program = ws_re.sub('-', program) target = target.strip() @@ -190,18 +196,21 @@ def xfileref_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): # remove all whitespace to avoid referencing problems target = ws_re.sub('', target) pnode['reftarget'] = target - pnode += innernodetypes.get(typ, nodes.literal)(rawtext, title, classes=['xref']) + pnode += innernodetypes.get(typ, nodes.literal)(rawtext, title, + classes=['xref']) return [pnode], [] def menusel_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): return [nodes.emphasis( - rawtext, utils.unescape(text).replace('-->', u'\N{TRIANGULAR BULLET}'))], [] + rawtext, + utils.unescape(text).replace('-->', u'\N{TRIANGULAR BULLET}'))], [] _litvar_re = re.compile('{([^}]+)}') -def emph_literal_role(typ, rawtext, text, lineno, inliner, options={}, content=[]): +def emph_literal_role(typ, rawtext, text, lineno, inliner, + options={}, content=[]): text = utils.unescape(text) pos = 0 retnode = nodes.literal(role=typ.lower()) diff --git a/sphinx/setup_command.py b/sphinx/setup_command.py index c874bdd4c..ac395f39b 100644 --- a/sphinx/setup_command.py +++ b/sphinx/setup_command.py @@ -84,6 +84,7 @@ class BuildDoc(Command): from docutils.utils import SystemMessage if isinstance(err, SystemMessage): sys.stderr, darkred('reST markup error:') - print >>sys.stderr, err.args[0].encode('ascii', 'backslashreplace') + print >>sys.stderr, err.args[0].encode('ascii', + 'backslashreplace') else: raise diff --git a/sphinx/themes/basic/layout.html b/sphinx/themes/basic/layout.html index f92e188c0..b4b1e7c57 100644 --- a/sphinx/themes/basic/layout.html +++ b/sphinx/themes/basic/layout.html @@ -68,8 +68,8 @@ {% include customsidebar %} {%- endif %} {%- block sidebarsearch %} - {%- if pagename != "search" %} - <div id="searchbox" style="display: none"> + {%- if pagename != "search" %} + <div id="searchbox" style="display: none"> <h3>{{ _('Quick search') }}</h3> <form class="search" action="{{ pathto('search') }}" method="get"> <input type="text" name="q" size="18" /> @@ -77,7 +77,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> - <p class="searchtip" style="font-size: 90%"> + <p class="searchtip" style="font-size: 90%"> {{ _('Enter search terms or a module, class or function name.') }} </p> </div> diff --git a/sphinx/util/smartypants.py b/sphinx/util/smartypants.py index 42f20f366..75888ea4d 100644 --- a/sphinx/util/smartypants.py +++ b/sphinx/util/smartypants.py @@ -162,7 +162,8 @@ def educateQuotes(s): """ # Special case if the very first character is a quote - # followed by punctuation at a non-word-break. Close the quotes by brute force: + # followed by punctuation at a non-word-break. Close the quotes + # by brute force: s = single_quote_start_re.sub("’", s) s = double_quote_start_re.sub("”", s) @@ -200,7 +201,8 @@ def educateQuotesLatex(s, dquotes=("``", "''")): """ # Special case if the very first character is a quote - # followed by punctuation at a non-word-break. Close the quotes by brute force: + # followed by punctuation at a non-word-break. Close the quotes + # by brute force: s = single_quote_start_re.sub("\x04", s) s = double_quote_start_re.sub("\x02", s) @@ -300,4 +302,5 @@ __author__ = "Chad Miller <smartypantspy@chad.org>" __version__ = "1.5_1.5: Sat, 13 Aug 2005 15:50:24 -0400" __url__ = "http://wiki.chad.org/SmartyPantsPy" __description__ = \ - "Smart-quotes, smart-ellipses, and smart-dashes for weblog entries in pyblosxom" + "Smart-quotes, smart-ellipses, and smart-dashes for weblog entries" \ + " in pyblosxom" diff --git a/sphinx/util/stemmer.py b/sphinx/util/stemmer.py index 7eeb77b2b..10ce90656 100644 --- a/sphinx/util/stemmer.py +++ b/sphinx/util/stemmer.py @@ -111,14 +111,16 @@ class PorterStemmer(object): return self.cons(j) def cvc(self, i): - """cvc(i) is TRUE <=> i-2,i-1,i has the form consonant - vowel - consonant + """cvc(i) is TRUE <=> i-2,i-1,i has the form + consonant - vowel - consonant and also if the second c is not w,x or y. this is used when trying to restore an e at the end of a short e.g. cav(e), lov(e), hop(e), crim(e), but snow, box, tray. """ - if i < (self.k0 + 2) or not self.cons(i) or self.cons(i-1) or not self.cons(i-2): + if i < (self.k0 + 2) or not self.cons(i) or self.cons(i-1) \ + or not self.cons(i-2): return 0 ch = self.b[i] if ch == 'w' or ch == 'x' or ch == 'y': @@ -138,7 +140,8 @@ class PorterStemmer(object): return 1 def setto(self, s): - """setto(s) sets (j+1),...k to the characters in the string s, readjusting k.""" + """setto(s) sets (j+1),...k to the characters in the string s, + readjusting k.""" length = len(s) self.b = self.b[:self.j+1] + s + self.b[self.j+length+1:] self.k = self.j + length @@ -193,7 +196,8 @@ class PorterStemmer(object): self.setto("e") def step1c(self): - """step1c() turns terminal y to i when there is another vowel in the stem.""" + """step1c() turns terminal y to i when there is another vowel in + the stem.""" if (self.ends("y") and self.vowelinstem()): self.b = self.b[:self.k] + 'i' + self.b[self.k+1:] @@ -236,7 +240,8 @@ class PorterStemmer(object): # To match the published algorithm, delete this phrase def step3(self): - """step3() dels with -ic-, -full, -ness etc. similar strategy to step2.""" + """step3() dels with -ic-, -full, -ness etc. similar strategy + to step2.""" if self.b[self.k] == 'e': if self.ends("icate"): self.r("ic") elif self.ends("ative"): self.r("") diff --git a/sphinx/writers/html.py b/sphinx/writers/html.py index 791976062..17a22b7a3 100644 --- a/sphinx/writers/html.py +++ b/sphinx/writers/html.py @@ -68,13 +68,15 @@ class HTMLTranslator(BaseTranslator): # the id is set automatically self.body.append(self.starttag(node, 'dt')) # anchor for per-desc interactive data - if node.parent['desctype'] != 'describe' and node['ids'] and node['first']: + if node.parent['desctype'] != 'describe' \ + and node['ids'] and node['first']: self.body.append('<!--[%s]-->' % node['ids'][0]) if node.parent['desctype'] in ('class', 'exception'): self.body.append('%s ' % node.parent['desctype']) def depart_desc_signature(self, node): if node['ids'] and self.add_permalinks and self.builder.add_permalinks: - self.body.append(u'<a class="headerlink" href="#%s" ' % node['ids'][0] + + self.body.append(u'<a class="headerlink" href="#%s" ' + % node['ids'][0] + u'title="%s">\u00B6</a>' % _('Permalink to this definition')) self.body.append('</dt>\n') @@ -192,14 +194,17 @@ class HTMLTranslator(BaseTranslator): # most probably a parsed-literal block -- don't highlight return BaseTranslator.visit_literal_block(self, node) lang = self.highlightlang - linenos = node.rawsource.count('\n') >= self.highlightlinenothreshold - 1 + linenos = node.rawsource.count('\n') >= \ + self.highlightlinenothreshold - 1 if node.has_key('language'): # code-block directives lang = node['language'] if node.has_key('linenos'): linenos = node['linenos'] - highlighted = self.highlighter.highlight_block(node.rawsource, lang, linenos) - starttag = self.starttag(node, 'div', suffix='', CLASS='highlight-%s' % lang) + highlighted = self.highlighter.highlight_block(node.rawsource, + lang, linenos) + starttag = self.starttag(node, 'div', suffix='', + CLASS='highlight-%s' % lang) self.body.append(starttag + highlighted + '</div>\n') raise nodes.SkipNode @@ -211,7 +216,8 @@ class HTMLTranslator(BaseTranslator): if len(node.children) == 1 and \ node.children[0] in ('None', 'True', 'False'): node['classes'].append('xref') - self.body.append(self.starttag(node, 'tt', '', CLASS='docutils literal')) + self.body.append(self.starttag(node, 'tt', '', + CLASS='docutils literal')) self.protect_literal_text += 1 def depart_literal(self, node): self.protect_literal_text -= 1 @@ -243,7 +249,8 @@ class HTMLTranslator(BaseTranslator): pass def visit_centered(self, node): - self.body.append(self.starttag(node, 'p', CLASS="centered") + '<strong>') + self.body.append(self.starttag(node, 'p', CLASS="centered") + + '<strong>') def depart_centered(self, node): self.body.append('</strong></p>') diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index 885cac44b..a9fa7662e 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -167,7 +167,8 @@ class LaTeXTranslator(nodes.NodeVisitor): 'pointsize': builder.config.latex_font_size, # if empty, the title is set to the first section title 'title': document.settings.title, - 'date': ustrftime(builder.config.today_fmt or _('%B %d, %Y')), + 'date': ustrftime(builder.config.today_fmt + or _('%B %d, %Y')), 'release': builder.config.release, 'author': document.settings.author, 'releasename': _('Release'), @@ -253,7 +254,8 @@ class LaTeXTranslator(nodes.NodeVisitor): for bi in self.bibitems: # cite_key: underscores must not be escaped cite_key = bi[0].replace(r"\_", "_") - self.body.append('\\bibitem[%s]{%s}{%s}\n' % (bi[0], cite_key, bi[1])) + self.body.append('\\bibitem[%s]{%s}{%s}\n' % + (bi[0], cite_key, bi[1])) self.body.append('\\end{thebibliography}\n') self.bibitems = [] @@ -304,7 +306,8 @@ class LaTeXTranslator(nodes.NodeVisitor): # self.body.append(r'\hypertarget{%s}{}' % id) # self.written_ids.add(id) def depart_section(self, node): - self.sectionlevel = max(self.sectionlevel - 1, self.top_sectionlevel - 1) + self.sectionlevel = max(self.sectionlevel - 1, + self.top_sectionlevel - 1) def visit_problematic(self, node): self.body.append(r'{\color{red}\bfseries{}') @@ -335,7 +338,8 @@ class LaTeXTranslator(nodes.NodeVisitor): def visit_production(self, node): if node['tokenname']: - self.body.append('\\production{%s}{' % self.encode(node['tokenname'])) + self.body.append('\\production{%s}{' % + self.encode(node['tokenname'])) else: self.body.append('\\productioncont{') def depart_production(self, node): @@ -352,7 +356,8 @@ class LaTeXTranslator(nodes.NodeVisitor): # the environment already handles this raise nodes.SkipNode elif self.this_is_the_title: - if len(node.children) != 1 and not isinstance(node.children[0], nodes.Text): + if len(node.children) != 1 and not isinstance(node.children[0], + nodes.Text): self.builder.warn('document title is not a single Text node') if not self.elements['title']: # text needs to be escaped since it is inserted into @@ -585,7 +590,8 @@ class LaTeXTranslator(nodes.NodeVisitor): else: if self.table.has_verbatim: colwidth = 0.95 / self.table.colcount - colspec = ('p{%.3f\\textwidth}|' % colwidth) * self.table.colcount + colspec = ('p{%.3f\\textwidth}|' % colwidth) * \ + self.table.colcount self.body.append('{|' + colspec + '}\n') else: self.body.append('{|' + ('L|' * self.table.colcount) + '}\n') @@ -648,7 +654,8 @@ class LaTeXTranslator(nodes.NodeVisitor): # this is a list in the source, but should be rendered as a # comma-separated list here self.body.append('\n\n') - self.body.append(', '.join(n.astext() for n in node.children[0].children) + '.') + self.body.append(', '.join(n.astext() + for n in node.children[0].children) + '.') self.body.append('\n\n') raise nodes.SkipNode @@ -743,9 +750,10 @@ class LaTeXTranslator(nodes.NodeVisitor): def visit_module(self, node): modname = node['modname'] - self.body.append('\n\\declaremodule[%s]{}{%s}' % (modname.replace('_', ''), - self.encode(modname))) - self.body.append('\n\\modulesynopsis{%s}' % self.encode(node['synopsis'])) + self.body.append('\n\\declaremodule[%s]{}{%s}' % ( + modname.replace('_', ''), self.encode(modname))) + self.body.append('\n\\modulesynopsis{%s}' % + self.encode(node['synopsis'])) if node.has_key('platform'): self.body.append('\\platform{%s}' % self.encode(node['platform'])) def depart_module(self, node): @@ -922,15 +930,18 @@ class LaTeXTranslator(nodes.NodeVisitor): entries = node['entries'] for type, string, tid, _ in entries: if type == 'single': - self.body.append(r'\index{%s}' % scre.sub('!', self.encode(string))) + self.body.append(r'\index{%s}' % + scre.sub('!', self.encode(string))) elif type == 'pair': - parts = tuple(self.encode(x.strip()) for x in string.split(';', 1)) + parts = tuple(self.encode(x.strip()) + for x in string.split(';', 1)) try: self.body.append(r'\indexii{%s}{%s}' % parts) except TypeError: self.builder.warn('invalid pair index entry %r' % string) elif type == 'triple': - parts = tuple(self.encode(x.strip()) for x in string.split(';', 2)) + parts = tuple(self.encode(x.strip()) + for x in string.split(';', 2)) try: self.body.append(r'\indexiii{%s}{%s}{%s}' % parts) except TypeError: @@ -957,7 +968,8 @@ class LaTeXTranslator(nodes.NodeVisitor): self.context.append('}') elif uri.startswith('%'): hashindex = uri.find('#') - targetname = (hashindex == -1) and '--doc-' + uri[1:] or uri[hashindex+1:] + targetname = (hashindex == -1) and '--doc-' + uri[1:] \ + or uri[hashindex+1:] self.body.append('\\hyperlink{%s}{' % targetname) self.context.append('}') elif uri.startswith('@token'): diff --git a/sphinx/writers/text.py b/sphinx/writers/text.py index 4718d41d3..787e70207 100644 --- a/sphinx/writers/text.py +++ b/sphinx/writers/text.py @@ -419,7 +419,8 @@ class TextTranslator(nodes.NodeVisitor): def visit_acks(self, node): self.new_state(0) - self.add_text(', '.join(n.astext() for n in node.children[0].children) + '.') + self.add_text(', '.join(n.astext() for n in node.children[0].children) + + '.') self.end_state() raise nodes.SkipNode diff --git a/utils/check_sources.py b/utils/check_sources.py index c244d9c0e..def13ee92 100755 --- a/utils/check_sources.py +++ b/utils/check_sources.py @@ -56,7 +56,7 @@ def check_syntax(fn, lines): def check_style_and_encoding(fn, lines): encoding = 'ascii' for lno, line in enumerate(lines): - if len(line) > 90: + if len(line) > 81: yield lno+1, "line too long" if lno < 2: co = coding_re.search(line) |