mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
builders: pep8 fixes
This commit is contained in:
parent
e97210e520
commit
8bc5823724
@ -19,7 +19,6 @@ except ImportError:
|
|||||||
multiprocessing = threading = None
|
multiprocessing = threading = None
|
||||||
|
|
||||||
from docutils import nodes
|
from docutils import nodes
|
||||||
from six import string_types
|
|
||||||
|
|
||||||
from sphinx.util import i18n, path_stabilize
|
from sphinx.util import i18n, path_stabilize
|
||||||
from sphinx.util.osutil import SEP, relative_uri, find_catalog
|
from sphinx.util.osutil import SEP, relative_uri, find_catalog
|
||||||
|
@ -33,6 +33,7 @@ except ImportError:
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
import gzip
|
import gzip
|
||||||
|
|
||||||
def comp_open(filename, mode='rb'):
|
def comp_open(filename, mode='rb'):
|
||||||
return gzip.open(filename + '.gz', mode)
|
return gzip.open(filename + '.gz', mode)
|
||||||
except ImportError:
|
except ImportError:
|
||||||
|
@ -242,7 +242,8 @@ class EpubBuilder(StandaloneHTMLBuilder):
|
|||||||
and pre and post files not managed by sphinx.
|
and pre and post files not managed by sphinx.
|
||||||
"""
|
"""
|
||||||
doctree = self.env.get_and_resolve_doctree(self.config.master_doc,
|
doctree = self.env.get_and_resolve_doctree(self.config.master_doc,
|
||||||
self, prune_toctrees=False, includehidden=True)
|
self, prune_toctrees=False,
|
||||||
|
includehidden=True)
|
||||||
self.refnodes = self.get_refnodes(doctree, [])
|
self.refnodes = self.get_refnodes(doctree, [])
|
||||||
master_dir = path.dirname(self.config.master_doc)
|
master_dir = path.dirname(self.config.master_doc)
|
||||||
if master_dir:
|
if master_dir:
|
||||||
@ -463,7 +464,6 @@ class EpubBuilder(StandaloneHTMLBuilder):
|
|||||||
StandaloneHTMLBuilder.handle_page(self, pagename, addctx, templatename,
|
StandaloneHTMLBuilder.handle_page(self, pagename, addctx, templatename,
|
||||||
outfilename, event_arg)
|
outfilename, event_arg)
|
||||||
|
|
||||||
|
|
||||||
# Finish by building the epub file
|
# Finish by building the epub file
|
||||||
def handle_finish(self):
|
def handle_finish(self):
|
||||||
"""Create the metainfo files and finally the epub."""
|
"""Create the metainfo files and finally the epub."""
|
||||||
@ -529,8 +529,8 @@ class EpubBuilder(StandaloneHTMLBuilder):
|
|||||||
olen = len(outdir)
|
olen = len(outdir)
|
||||||
projectfiles = []
|
projectfiles = []
|
||||||
self.files = []
|
self.files = []
|
||||||
self.ignored_files = ['.buildinfo',
|
self.ignored_files = ['.buildinfo', 'mimetype', 'content.opf',
|
||||||
'mimetype', 'content.opf', 'toc.ncx', 'META-INF/container.xml',
|
'toc.ncx', 'META-INF/container.xml',
|
||||||
self.config.epub_basename + '.epub'] + \
|
self.config.epub_basename + '.epub'] + \
|
||||||
self.config.epub_exclude_files
|
self.config.epub_exclude_files
|
||||||
for root, dirs, files in os.walk(outdir):
|
for root, dirs, files in os.walk(outdir):
|
||||||
@ -719,7 +719,8 @@ class EpubBuilder(StandaloneHTMLBuilder):
|
|||||||
|
|
||||||
if self.config.epub_tocscope == 'default':
|
if self.config.epub_tocscope == 'default':
|
||||||
doctree = self.env.get_and_resolve_doctree(self.config.master_doc,
|
doctree = self.env.get_and_resolve_doctree(self.config.master_doc,
|
||||||
self, prune_toctrees=False, includehidden=False)
|
self, prune_toctrees=False,
|
||||||
|
includehidden=False)
|
||||||
refnodes = self.get_refnodes(doctree, [])
|
refnodes = self.get_refnodes(doctree, [])
|
||||||
self.toc_add_files(refnodes)
|
self.toc_add_files(refnodes)
|
||||||
else:
|
else:
|
||||||
|
@ -130,6 +130,7 @@ timestamp = time()
|
|||||||
tzdelta = datetime.fromtimestamp(timestamp) - \
|
tzdelta = datetime.fromtimestamp(timestamp) - \
|
||||||
datetime.utcfromtimestamp(timestamp)
|
datetime.utcfromtimestamp(timestamp)
|
||||||
|
|
||||||
|
|
||||||
class LocalTimeZone(tzinfo):
|
class LocalTimeZone(tzinfo):
|
||||||
|
|
||||||
def __init__(self, *args, **kw):
|
def __init__(self, *args, **kw):
|
||||||
@ -213,8 +214,8 @@ class MessageCatalogBuilder(I18nBuilder):
|
|||||||
|
|
||||||
if self.config.gettext_location:
|
if self.config.gettext_location:
|
||||||
# generate "#: file1:line1\n#: file2:line2 ..."
|
# generate "#: file1:line1\n#: file2:line2 ..."
|
||||||
pofile.write("#: %s\n" % "\n#: ".join("%s:%s" %
|
pofile.write("#: %s\n" % "\n#: ".join(
|
||||||
(safe_relpath(source, self.outdir), line)
|
"%s:%s" % (safe_relpath(source, self.outdir), line)
|
||||||
for source, line, _ in positions))
|
for source, line, _ in positions))
|
||||||
if self.config.gettext_uuid:
|
if self.config.gettext_uuid:
|
||||||
# generate "# uuid1\n# uuid2\n ..."
|
# generate "# uuid1\n# uuid2\n ..."
|
||||||
|
@ -394,8 +394,9 @@ class StandaloneHTMLBuilder(Builder):
|
|||||||
pass
|
pass
|
||||||
related = self.relations.get(related[0])
|
related = self.relations.get(related[0])
|
||||||
if parents:
|
if parents:
|
||||||
parents.pop() # remove link to the master file; we have a generic
|
# remove link to the master file; we have a generic
|
||||||
# "back to index" link already
|
# "back to index" link already
|
||||||
|
parents.pop()
|
||||||
parents.reverse()
|
parents.reverse()
|
||||||
|
|
||||||
# title rendered as HTML
|
# title rendered as HTML
|
||||||
@ -505,7 +506,7 @@ class StandaloneHTMLBuilder(Builder):
|
|||||||
# the entries into two columns
|
# the entries into two columns
|
||||||
genindex = self.env.create_index(self)
|
genindex = self.env.create_index(self)
|
||||||
indexcounts = []
|
indexcounts = []
|
||||||
for _, entries in genindex:
|
for _k, entries in genindex:
|
||||||
indexcounts.append(sum(1 + len(subitems)
|
indexcounts.append(sum(1 + len(subitems)
|
||||||
for _, (_, subitems) in entries))
|
for _, (_, subitems) in entries))
|
||||||
|
|
||||||
@ -821,8 +822,7 @@ class StandaloneHTMLBuilder(Builder):
|
|||||||
u'# Project: %s\n'
|
u'# Project: %s\n'
|
||||||
u'# Version: %s\n'
|
u'# Version: %s\n'
|
||||||
u'# The remainder of this file is compressed using zlib.\n'
|
u'# The remainder of this file is compressed using zlib.\n'
|
||||||
% (self.config.project, self.config.version)
|
% (self.config.project, self.config.version)).encode('utf-8'))
|
||||||
).encode('utf-8'))
|
|
||||||
compressor = zlib.compressobj(9)
|
compressor = zlib.compressobj(9)
|
||||||
for domainname, domain in iteritems(self.env.domains):
|
for domainname, domain in iteritems(self.env.domains):
|
||||||
for name, dispname, type, docname, anchor, prio in \
|
for name, dispname, type, docname, anchor, prio in \
|
||||||
@ -835,8 +835,7 @@ class StandaloneHTMLBuilder(Builder):
|
|||||||
dispname = u'-'
|
dispname = u'-'
|
||||||
f.write(compressor.compress(
|
f.write(compressor.compress(
|
||||||
(u'%s %s:%s %s %s %s\n' % (name, domainname, type,
|
(u'%s %s:%s %s %s %s\n' % (name, domainname, type,
|
||||||
prio, uri, dispname)
|
prio, uri, dispname)).encode('utf-8')))
|
||||||
).encode('utf-8')))
|
|
||||||
f.write(compressor.flush())
|
f.write(compressor.flush())
|
||||||
finally:
|
finally:
|
||||||
f.close()
|
f.close()
|
||||||
@ -879,8 +878,8 @@ class DirectoryHTMLBuilder(StandaloneHTMLBuilder):
|
|||||||
|
|
||||||
def get_outfilename(self, pagename):
|
def get_outfilename(self, pagename):
|
||||||
if pagename == 'index' or pagename.endswith(SEP + 'index'):
|
if pagename == 'index' or pagename.endswith(SEP + 'index'):
|
||||||
outfilename = path.join(self.outdir, os_path(pagename)
|
outfilename = path.join(self.outdir, os_path(pagename) +
|
||||||
+ self.out_suffix)
|
self.out_suffix)
|
||||||
else:
|
else:
|
||||||
outfilename = path.join(self.outdir, os_path(pagename),
|
outfilename = path.join(self.outdir, os_path(pagename),
|
||||||
'index' + self.out_suffix)
|
'index' + self.out_suffix)
|
||||||
|
@ -239,6 +239,7 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder):
|
|||||||
# the TOC
|
# the TOC
|
||||||
tocdoc = self.env.get_and_resolve_doctree(
|
tocdoc = self.env.get_and_resolve_doctree(
|
||||||
self.config.master_doc, self, prune_toctrees=False)
|
self.config.master_doc, self, prune_toctrees=False)
|
||||||
|
|
||||||
def write_toc(node, ullevel=0):
|
def write_toc(node, ullevel=0):
|
||||||
if isinstance(node, nodes.list_item):
|
if isinstance(node, nodes.list_item):
|
||||||
f.write('<LI> ')
|
f.write('<LI> ')
|
||||||
@ -258,6 +259,7 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder):
|
|||||||
elif isinstance(node, addnodes.compact_paragraph):
|
elif isinstance(node, addnodes.compact_paragraph):
|
||||||
for subnode in node:
|
for subnode in node:
|
||||||
write_toc(subnode, ullevel)
|
write_toc(subnode, ullevel)
|
||||||
|
|
||||||
def istoctree(node):
|
def istoctree(node):
|
||||||
return isinstance(node, addnodes.compact_paragraph) and \
|
return isinstance(node, addnodes.compact_paragraph) and \
|
||||||
'toctree' in node
|
'toctree' in node
|
||||||
@ -272,6 +274,7 @@ class HTMLHelpBuilder(StandaloneHTMLBuilder):
|
|||||||
f = self.open_file(outdir, outname+'.hhk')
|
f = self.open_file(outdir, outname+'.hhk')
|
||||||
try:
|
try:
|
||||||
f.write('<UL>\n')
|
f.write('<UL>\n')
|
||||||
|
|
||||||
def write_index(title, refs, subitems):
|
def write_index(title, refs, subitems):
|
||||||
def write_param(name, value):
|
def write_param(name, value):
|
||||||
item = ' <param name="%s" value="%s">\n' % \
|
item = ' <param name="%s" value="%s">\n' % \
|
||||||
|
@ -94,9 +94,9 @@ class LaTeXBuilder(Builder):
|
|||||||
destination_path=path.join(self.outdir, targetname),
|
destination_path=path.join(self.outdir, targetname),
|
||||||
encoding='utf-8')
|
encoding='utf-8')
|
||||||
self.info("processing " + targetname + "... ", nonl=1)
|
self.info("processing " + targetname + "... ", nonl=1)
|
||||||
doctree = self.assemble_doctree(docname, toctree_only,
|
doctree = self.assemble_doctree(
|
||||||
appendices=((docclass != 'howto') and
|
docname, toctree_only,
|
||||||
self.config.latex_appendices or []))
|
appendices=((docclass != 'howto') and self.config.latex_appendices or []))
|
||||||
self.post_process_images(doctree)
|
self.post_process_images(doctree)
|
||||||
self.info("writing... ", nonl=1)
|
self.info("writing... ", nonl=1)
|
||||||
doctree.settings = docsettings
|
doctree.settings = docsettings
|
||||||
|
@ -122,9 +122,10 @@ class QtHelpBuilder(StandaloneHTMLBuilder):
|
|||||||
# sections
|
# sections
|
||||||
tocdoc = self.env.get_and_resolve_doctree(self.config.master_doc, self,
|
tocdoc = self.env.get_and_resolve_doctree(self.config.master_doc, self,
|
||||||
prune_toctrees=False)
|
prune_toctrees=False)
|
||||||
istoctree = lambda node: (
|
|
||||||
isinstance(node, addnodes.compact_paragraph)
|
def istoctree(node):
|
||||||
and 'toctree' in node)
|
return isinstance(node, addnodes.compact_paragraph) and \
|
||||||
|
'toctree' in node
|
||||||
sections = []
|
sections = []
|
||||||
for node in tocdoc.traverse(istoctree):
|
for node in tocdoc.traverse(istoctree):
|
||||||
sections.extend(self.write_toc(node))
|
sections.extend(self.write_toc(node))
|
||||||
|
@ -88,7 +88,7 @@ class TexinfoBuilder(Builder):
|
|||||||
name = 'texinfo'
|
name = 'texinfo'
|
||||||
format = 'texinfo'
|
format = 'texinfo'
|
||||||
supported_image_types = ['image/png', 'image/jpeg',
|
supported_image_types = ['image/png', 'image/jpeg',
|
||||||
'image/gif',]
|
'image/gif']
|
||||||
|
|
||||||
def init(self):
|
def init(self):
|
||||||
self.docnames = []
|
self.docnames = []
|
||||||
@ -141,7 +141,8 @@ class TexinfoBuilder(Builder):
|
|||||||
destination_path=path.join(self.outdir, targetname),
|
destination_path=path.join(self.outdir, targetname),
|
||||||
encoding='utf-8')
|
encoding='utf-8')
|
||||||
self.info("processing " + targetname + "... ", nonl=1)
|
self.info("processing " + targetname + "... ", nonl=1)
|
||||||
doctree = self.assemble_doctree(docname, toctree_only,
|
doctree = self.assemble_doctree(
|
||||||
|
docname, toctree_only,
|
||||||
appendices=(self.config.texinfo_appendices or []))
|
appendices=(self.config.texinfo_appendices or []))
|
||||||
self.info("writing... ", nonl=1)
|
self.info("writing... ", nonl=1)
|
||||||
self.post_process_images(doctree)
|
self.post_process_images(doctree)
|
||||||
|
@ -19,6 +19,7 @@ from sphinx.builders import Builder
|
|||||||
from sphinx.util.osutil import ensuredir, os_path
|
from sphinx.util.osutil import ensuredir, os_path
|
||||||
from sphinx.writers.xml import XMLWriter, PseudoXMLWriter
|
from sphinx.writers.xml import XMLWriter, PseudoXMLWriter
|
||||||
|
|
||||||
|
|
||||||
class XMLBuilder(Builder):
|
class XMLBuilder(Builder):
|
||||||
"""
|
"""
|
||||||
Builds Docutils-native XML.
|
Builds Docutils-native XML.
|
||||||
|
Loading…
Reference in New Issue
Block a user