"""Template for creating a new writer."""
__author__ = "Patrick K. O'Brien "
__cvsid__ = "$Id$"
__revision__ = "$Revision$"[11:-2]
__docformat__ = 'reStructuredText'
import sys
import os
import time
import re
from types import ListType
import docutils
from docutils import nodes, utils, writers, languages
class Writer(writers.Writer):
supported = ('SomeFormat')
"""Formats this writer supports."""
output = None
"""Final translated form of `document`."""
def __init__(self):
writers.Writer.__init__(self)
self.translator_class = Translator
def translate(self):
visitor = self.translator_class(self.document)
self.document.walkabout(visitor)
self.output = visitor.astext()
class Translator(nodes.NodeVisitor):
"""Modify this to suite your needs."""
words_and_spaces = re.compile(r'\S+| +|\n')
def __init__(self, document):
nodes.NodeVisitor.__init__(self, document)
self.settings = settings = document.settings
lcode = settings.language_code
self.language = languages.get_language(lcode)
self.head = []
self.body = []
self.foot = []
self.section_level = 0
self.context = []
self.topic_class = ''
self.colspecs = []
self.compact_p = 1
self.compact_simple = None
self.in_docinfo = None
def astext(self):
"""Return the final formatted document as a string."""
raise NotImplementedError
return ''.join(self.head + self.body + self.foot)
def visit_Text(self, node):
raise NotImplementedError, node.astext()
self.body.append(node.astext())
def depart_Text(self, node):
pass
def visit_address(self, node):
raise NotImplementedError, node.astext()
self.visit_docinfo_item(node, 'address', meta=None)
def depart_address(self, node):
self.depart_docinfo_item()
def visit_admonition(self, node, name):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'div', CLASS=name))
self.body.append(''
+ self.language.labels[name] + '
\n')
def depart_admonition(self):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_attention(self, node):
self.visit_admonition(node, 'attention')
def depart_attention(self, node):
self.depart_admonition()
def visit_author(self, node):
raise NotImplementedError, node.astext()
self.visit_docinfo_item(node, 'author')
def depart_author(self, node):
self.depart_docinfo_item()
def visit_authors(self, node):
pass
def depart_authors(self, node):
pass
def visit_block_quote(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'blockquote'))
def depart_block_quote(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def check_simple_list(self, node):
raise NotImplementedError, node.astext()
"""Check for a simple list that can be rendered compactly."""
visitor = SimpleListChecker(self.document)
try:
node.walk(visitor)
except nodes.NodeFound:
return None
else:
return 1
def visit_bullet_list(self, node):
raise NotImplementedError, node.astext()
atts = {}
old_compact_simple = self.compact_simple
self.context.append((self.compact_simple, self.compact_p))
self.compact_p = None
self.compact_simple = (self.settings.compact_lists and
(self.compact_simple
or self.topic_class == 'contents'
or self.check_simple_list(node)))
if self.compact_simple and not old_compact_simple:
atts['class'] = 'simple'
self.body.append(self.starttag(node, 'ul', **atts))
def depart_bullet_list(self, node):
raise NotImplementedError, node.astext()
self.compact_simple, self.compact_p = self.context.pop()
self.body.append('\n')
def visit_caption(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'p', '', CLASS='caption'))
def depart_caption(self, node):
raise NotImplementedError, node.astext()
self.body.append('
\n')
def visit_caution(self, node):
self.visit_admonition(node, 'caution')
def depart_caution(self, node):
self.depart_admonition()
def visit_citation(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'table', CLASS='citation',
frame="void", rules="none"))
self.body.append('\n'
'\n'
'\n'
'')
self.footnote_backrefs(node)
def depart_citation(self, node):
raise NotImplementedError, node.astext()
self.body.append('
\n'
'\n\n')
def visit_citation_reference(self, node):
raise NotImplementedError, node.astext()
href = ''
if node.has_key('refid'):
href = '#' + node['refid']
elif node.has_key('refname'):
href = '#' + self.document.nameids[node['refname']]
self.body.append(self.starttag(node, 'a', '[', href=href,
CLASS='citation-reference'))
def depart_citation_reference(self, node):
raise NotImplementedError, node.astext()
self.body.append(']')
def visit_classifier(self, node):
raise NotImplementedError, node.astext()
self.body.append(' : ')
self.body.append(self.starttag(node, 'span', '', CLASS='classifier'))
def depart_classifier(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
def visit_colspec(self, node):
self.colspecs.append(node)
def depart_colspec(self, node):
pass
def write_colspecs(self):
raise NotImplementedError, node.astext()
width = 0
for node in self.colspecs:
width += node['colwidth']
for node in self.colspecs:
colwidth = int(node['colwidth'] * 100.0 / width + 0.5)
self.body.append(self.emptytag(node, 'col',
width='%i%%' % colwidth))
self.colspecs = []
def visit_comment(self, node,
sub=re.compile('-(?=-)').sub):
raise NotImplementedError, node.astext()
"""Escape double-dashes in comment text."""
self.body.append('\n' % sub('- ', node.astext()))
# Content already processed:
raise nodes.SkipNode
def visit_contact(self, node):
raise NotImplementedError, node.astext()
self.visit_docinfo_item(node, 'contact', meta=None)
def depart_contact(self, node):
self.depart_docinfo_item()
def visit_copyright(self, node):
raise NotImplementedError, node.astext()
self.visit_docinfo_item(node, 'copyright')
def depart_copyright(self, node):
self.depart_docinfo_item()
def visit_danger(self, node):
self.visit_admonition(node, 'danger')
def depart_danger(self, node):
self.depart_admonition()
def visit_date(self, node):
raise NotImplementedError, node.astext()
self.visit_docinfo_item(node, 'date')
def depart_date(self, node):
self.depart_docinfo_item()
def visit_decoration(self, node):
pass
def depart_decoration(self, node):
pass
def visit_definition(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
self.body.append(self.starttag(node, 'dd', ''))
if len(node):
node[0].set_class('first')
node[-1].set_class('last')
def depart_definition(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_definition_list(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'dl'))
def depart_definition_list(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_definition_list_item(self, node):
pass
def depart_definition_list_item(self, node):
pass
def visit_description(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'td', ''))
if len(node):
node[0].set_class('first')
node[-1].set_class('last')
def depart_description(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
def visit_docinfo(self, node):
raise NotImplementedError, node.astext()
self.context.append(len(self.body))
self.body.append(self.starttag(node, 'table', CLASS='docinfo',
frame="void", rules="none"))
self.body.append('\n'
'\n'
'\n')
self.in_docinfo = 1
def depart_docinfo(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n\n')
self.in_docinfo = None
start = self.context.pop()
self.body_pre_docinfo = self.body[:start]
self.docinfo = self.body[start:]
self.body = []
def visit_docinfo_item(self, node, name, meta=1):
raise NotImplementedError, node.astext()
if meta:
self.head.append('\n'
% (name, self.attval(node.astext())))
self.body.append(self.starttag(node, 'tr', ''))
self.body.append('%s: | \n'
% self.language.labels[name])
if len(node):
if isinstance(node[0], nodes.Element):
node[0].set_class('first')
if isinstance(node[0], nodes.Element):
node[-1].set_class('last')
def depart_docinfo_item(self):
raise NotImplementedError, node.astext()
self.body.append(' | \n')
def visit_doctest_block(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'pre', CLASS='doctest-block'))
def depart_doctest_block(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n\n')
def visit_document(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'div', CLASS='document'))
def depart_document(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_emphasis(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
def depart_emphasis(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
def visit_entry(self, node):
raise NotImplementedError, node.astext()
if isinstance(node.parent.parent, nodes.thead):
tagname = 'th'
else:
tagname = 'td'
atts = {}
if node.has_key('morerows'):
atts['rowspan'] = node['morerows'] + 1
if node.has_key('morecols'):
atts['colspan'] = node['morecols'] + 1
self.body.append(self.starttag(node, tagname, '', **atts))
self.context.append('%s>\n' % tagname.lower())
if len(node) == 0: # empty cell
self.body.append(' ')
else:
node[0].set_class('first')
node[-1].set_class('last')
def depart_entry(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.context.pop())
def visit_enumerated_list(self, node):
raise NotImplementedError, node.astext()
"""
The 'start' attribute does not conform to HTML 4.01's strict.dtd, but
CSS1 doesn't help. CSS2 isn't widely enough supported yet to be
usable.
"""
atts = {}
if node.has_key('start'):
atts['start'] = node['start']
if node.has_key('enumtype'):
atts['class'] = node['enumtype']
# @@@ To do: prefix, suffix. How? Change prefix/suffix to a
# single "format" attribute? Use CSS2?
old_compact_simple = self.compact_simple
self.context.append((self.compact_simple, self.compact_p))
self.compact_p = None
self.compact_simple = (self.settings.compact_lists and
(self.compact_simple
or self.topic_class == 'contents'
or self.check_simple_list(node)))
if self.compact_simple and not old_compact_simple:
atts['class'] = (atts.get('class', '') + ' simple').strip()
self.body.append(self.starttag(node, 'ol', **atts))
def depart_enumerated_list(self, node):
raise NotImplementedError, node.astext()
self.compact_simple, self.compact_p = self.context.pop()
self.body.append('\n')
def visit_error(self, node):
self.visit_admonition(node, 'error')
def depart_error(self, node):
self.depart_admonition()
def visit_field(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'tr', '', CLASS='field'))
def depart_field(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_field_body(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'td', '', CLASS='field-body'))
if len(node):
node[0].set_class('first')
node[-1].set_class('last')
def depart_field_body(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_field_list(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'table', frame='void',
rules='none', CLASS='field-list'))
self.body.append('\n'
'\n'
'\n')
def depart_field_list(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n\n')
def visit_field_name(self, node):
raise NotImplementedError, node.astext()
atts = {}
if self.in_docinfo:
atts['class'] = 'docinfo-name'
else:
atts['class'] = 'field-name'
if len(node.astext()) > 14:
atts['colspan'] = 2
self.context.append('\n | ')
else:
self.context.append('')
self.body.append(self.starttag(node, 'th', '', **atts))
def depart_field_name(self, node):
raise NotImplementedError, node.astext()
self.body.append(':')
self.body.append(self.context.pop())
def visit_figure(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'div', CLASS='figure'))
def depart_figure(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_footer(self, node):
raise NotImplementedError, node.astext()
self.context.append(len(self.body))
def depart_footer(self, node):
raise NotImplementedError, node.astext()
start = self.context.pop()
footer = (['\n',
self.starttag(node, 'div', CLASS='footer')]
+ self.body[start:] + ['\n'])
self.body_suffix[:0] = footer
del self.body[start:]
def visit_footnote(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'table', CLASS='footnote',
frame="void", rules="none"))
self.body.append('\n'
'
\n'
'')
self.footnote_backrefs(node)
def footnote_backrefs(self, node):
raise NotImplementedError, node.astext()
if self.settings.footnote_backlinks and node.hasattr('backrefs'):
backrefs = node['backrefs']
if len(backrefs) == 1:
self.context.append('')
self.context.append('' % (backrefs[0], node['id']))
else:
i = 1
backlinks = []
for backref in backrefs:
backlinks.append('%s'
% (backref, i))
i += 1
self.context.append('(%s) ' % ', '.join(backlinks))
self.context.append('' % node['id'])
else:
self.context.append('')
self.context.append('' % node['id'])
def depart_footnote(self, node):
raise NotImplementedError, node.astext()
self.body.append('
\n'
'\n\n')
def visit_footnote_reference(self, node):
raise NotImplementedError, node.astext()
href = ''
if node.has_key('refid'):
href = '#' + node['refid']
elif node.has_key('refname'):
href = '#' + self.document.nameids[node['refname']]
format = self.settings.footnote_references
if format == 'brackets':
suffix = '['
self.context.append(']')
elif format == 'superscript':
suffix = ''
self.context.append('')
else: # shouldn't happen
suffix = '???'
self.content.append('???')
self.body.append(self.starttag(node, 'a', suffix, href=href,
CLASS='footnote-reference'))
def depart_footnote_reference(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.context.pop() + '')
def visit_generated(self, node):
pass
def depart_generated(self, node):
pass
def visit_header(self, node):
raise NotImplementedError, node.astext()
self.context.append(len(self.body))
def depart_header(self, node):
raise NotImplementedError, node.astext()
start = self.context.pop()
self.body_prefix.append(self.starttag(node, 'div', CLASS='header'))
self.body_prefix.extend(self.body[start:])
self.body_prefix.append('
\n\n')
del self.body[start:]
def visit_hint(self, node):
self.visit_admonition(node, 'hint')
def depart_hint(self, node):
self.depart_admonition()
def visit_image(self, node):
raise NotImplementedError, node.astext()
atts = node.attributes.copy()
atts['src'] = atts['uri']
del atts['uri']
if not atts.has_key('alt'):
atts['alt'] = atts['src']
if isinstance(node.parent, nodes.TextElement):
self.context.append('')
else:
self.body.append('')
self.context.append('
\n')
self.body.append(self.emptytag(node, 'img', '', **atts))
def depart_image(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.context.pop())
def visit_important(self, node):
self.visit_admonition(node, 'important')
def depart_important(self, node):
self.depart_admonition()
def visit_label(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'td', '%s[' % self.context.pop(),
CLASS='label'))
def depart_label(self, node):
raise NotImplementedError, node.astext()
self.body.append(']%s' % self.context.pop())
def visit_legend(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'div', CLASS='legend'))
def depart_legend(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_line_block(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'pre', CLASS='line-block'))
def depart_line_block(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n\n')
def visit_list_item(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'li', ''))
if len(node):
node[0].set_class('first')
def depart_list_item(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_literal(self, node):
raise NotImplementedError, node.astext()
"""Process text to prevent tokens from wrapping."""
self.body.append(self.starttag(node, 'tt', '', CLASS='literal'))
text = node.astext()
for token in self.words_and_spaces.findall(text):
if token.strip():
# Protect text like "--an-option" from bad line wrapping:
self.body.append('%s'
% self.encode(token))
elif token in ('\n', ' '):
# Allow breaks at whitespace:
self.body.append(token)
else:
# Protect runs of multiple spaces; the last space can wrap:
self.body.append(' ' * (len(token) - 1) + ' ')
self.body.append('')
# Content already processed:
raise nodes.SkipNode
def visit_literal_block(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'pre', CLASS='literal-block'))
def depart_literal_block(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n\n')
def visit_meta(self, node):
raise NotImplementedError, node.astext()
self.head.append(self.emptytag(node, 'meta', **node.attributes))
def depart_meta(self, node):
pass
def visit_note(self, node):
self.visit_admonition(node, 'note')
def depart_note(self, node):
self.depart_admonition()
def visit_option(self, node):
raise NotImplementedError, node.astext()
if self.context[-1]:
self.body.append(', ')
def depart_option(self, node):
raise NotImplementedError, node.astext()
self.context[-1] += 1
def visit_option_argument(self, node):
raise NotImplementedError, node.astext()
self.body.append(node.get('delimiter', ' '))
self.body.append(self.starttag(node, 'var', ''))
def depart_option_argument(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
def visit_option_group(self, node):
raise NotImplementedError, node.astext()
atts = {}
if len(node.astext()) > 14:
atts['colspan'] = 2
self.context.append('\n | | ')
else:
self.context.append('')
self.body.append(self.starttag(node, 'td', **atts))
self.body.append('')
self.context.append(0) # count number of options
def depart_option_group(self, node):
raise NotImplementedError, node.astext()
self.context.pop()
self.body.append('\n')
self.body.append(self.context.pop())
def visit_option_list(self, node):
raise NotImplementedError, node.astext()
self.body.append(
self.starttag(node, 'table', CLASS='option-list',
frame="void", rules="none"))
self.body.append('\n'
'\n'
'
\n')
def depart_option_list(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n\n')
def visit_option_list_item(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'tr', ''))
def depart_option_list_item(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_option_string(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'span', '', CLASS='option'))
def depart_option_string(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
def visit_organization(self, node):
raise NotImplementedError, node.astext()
self.visit_docinfo_item(node, 'organization')
def depart_organization(self, node):
raise NotImplementedError, node.astext()
self.depart_docinfo_item()
def visit_paragraph(self, node):
raise NotImplementedError, node.astext()
# Omit tags if this is an only child and optimizable.
if (self.compact_simple or
self.compact_p and (len(node.parent) == 1 or
len(node.parent) == 2 and
isinstance(node.parent[0], nodes.label))):
self.context.append('')
else:
self.body.append(self.starttag(node, 'p', ''))
self.context.append('
\n')
def depart_paragraph(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.context.pop())
def visit_problematic(self, node):
raise NotImplementedError, node.astext()
if node.hasattr('refid'):
self.body.append('' % (node['refid'],
node['id']))
self.context.append('')
else:
self.context.append('')
self.body.append(self.starttag(node, 'span', '', CLASS='problematic'))
def depart_problematic(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
self.body.append(self.context.pop())
def visit_raw(self, node):
raise NotImplementedError, node.astext()
if node.get('format') == 'html':
self.body.append(node.astext())
# Keep non-HTML raw text out of output:
raise nodes.SkipNode
def visit_reference(self, node):
raise NotImplementedError, node.astext()
if node.has_key('refuri'):
href = node['refuri']
elif node.has_key('refid'):
href = '#' + node['refid']
elif node.has_key('refname'):
href = '#' + self.document.nameids[node['refname']]
self.body.append(self.starttag(node, 'a', '', href=href,
CLASS='reference'))
def depart_reference(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
def visit_revision(self, node):
raise NotImplementedError, node.astext()
self.visit_docinfo_item(node, 'revision', meta=None)
def depart_revision(self, node):
self.depart_docinfo_item()
def visit_row(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'tr', ''))
def depart_row(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_section(self, node):
raise NotImplementedError, node.astext()
self.section_level += 1
self.body.append(self.starttag(node, 'div', CLASS='section'))
def depart_section(self, node):
raise NotImplementedError, node.astext()
self.section_level -= 1
self.body.append('\n')
def visit_status(self, node):
raise NotImplementedError, node.astext()
self.visit_docinfo_item(node, 'status', meta=None)
def depart_status(self, node):
self.depart_docinfo_item()
def visit_strong(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
def depart_strong(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
def visit_substitution_definition(self, node):
"""Internal only."""
raise nodes.SkipNode
def visit_substitution_reference(self, node):
self.unimplemented_visit(node)
def visit_subtitle(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'h2', '', CLASS='subtitle'))
def depart_subtitle(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_system_message(self, node):
raise NotImplementedError, node.astext()
if node['level'] < self.document.reporter['writer'].report_level:
# Level is too low to display:
raise nodes.SkipNode
self.body.append(self.starttag(node, 'div', CLASS='system-message'))
self.body.append('')
attr = {}
backref_text = ''
if node.hasattr('id'):
attr['name'] = node['id']
if node.hasattr('backrefs'):
backrefs = node['backrefs']
if len(backrefs) == 1:
backref_text = ('; backlink'
% backrefs[0])
else:
i = 1
backlinks = []
for backref in backrefs:
backlinks.append('%s' % (backref, i))
i += 1
backref_text = ('; backlinks: %s'
% ', '.join(backlinks))
if node.hasattr('line'):
line = ', line %s' % node['line']
else:
line = ''
if attr:
a_start = self.starttag({}, 'a', '', **attr)
a_end = ''
else:
a_start = a_end = ''
self.body.append('System Message: %s%s/%s%s (%s%s)%s
\n'
% (a_start, node['type'], node['level'], a_end,
node['source'], line, backref_text))
def depart_system_message(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_table(self, node):
raise NotImplementedError, node.astext()
self.body.append(
self.starttag(node, 'table', CLASS="table",
frame='border', rules='all'))
def depart_table(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_target(self, node):
raise NotImplementedError, node.astext()
if not (node.has_key('refuri') or node.has_key('refid')
or node.has_key('refname')):
self.body.append(self.starttag(node, 'a', '', CLASS='target'))
self.context.append('')
else:
self.context.append('')
def depart_target(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.context.pop())
def visit_tbody(self, node):
raise NotImplementedError, node.astext()
self.write_colspecs()
self.body.append(self.context.pop()) # '\n' or ''
self.body.append(self.starttag(node, 'tbody', valign='top'))
def depart_tbody(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_term(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'dt', ''))
def depart_term(self, node):
"""
Leave the end tag to `self.visit_definition()`, in case there's a
classifier.
"""
raise NotImplementedError, node.astext()
pass
def visit_tgroup(self, node):
raise NotImplementedError, node.astext()
# Mozilla needs :
self.body.append(self.starttag(node, 'colgroup'))
# Appended by thead or tbody:
self.context.append('\n')
def depart_tgroup(self, node):
pass
def visit_thead(self, node):
raise NotImplementedError, node.astext()
self.write_colspecs()
self.body.append(self.context.pop()) # '\n'
# There may or may not be a ; this is for to use:
self.context.append('')
self.body.append(self.starttag(node, 'thead', valign='bottom'))
def depart_thead(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
def visit_tip(self, node):
self.visit_admonition(node, 'tip')
def depart_tip(self, node):
self.depart_admonition()
def visit_title(self, node):
raise NotImplementedError, node.astext()
"""Only 6 section levels are supported by HTML."""
if isinstance(node.parent, nodes.topic):
self.body.append(
self.starttag(node, 'p', '', CLASS='topic-title'))
if node.parent.hasattr('id'):
self.body.append(
self.starttag({}, 'a', '', name=node.parent['id']))
self.context.append('\n')
else:
self.context.append('\n')
elif self.section_level == 0:
# document title
self.head.append('%s\n'
% self.encode(node.astext()))
self.body.append(self.starttag(node, 'h1', '', CLASS='title'))
self.context.append('\n')
else:
self.body.append(
self.starttag(node, 'h%s' % self.section_level, ''))
atts = {}
if node.parent.hasattr('id'):
atts['name'] = node.parent['id']
if node.hasattr('refid'):
atts['class'] = 'toc-backref'
atts['href'] = '#' + node['refid']
self.body.append(self.starttag({}, 'a', '', **atts))
self.context.append('\n' % (self.section_level))
def depart_title(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.context.pop())
def visit_title_reference(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'cite', ''))
def depart_title_reference(self, node):
raise NotImplementedError, node.astext()
self.body.append('')
def visit_topic(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.starttag(node, 'div', CLASS='topic'))
self.topic_class = node.get('class')
def depart_topic(self, node):
raise NotImplementedError, node.astext()
self.body.append('\n')
self.topic_class = ''
def visit_transition(self, node):
raise NotImplementedError, node.astext()
self.body.append(self.emptytag(node, 'hr'))
def depart_transition(self, node):
pass
def visit_version(self, node):
raise NotImplementedError, node.astext()
self.visit_docinfo_item(node, 'version', meta=None)
def depart_version(self, node):
self.depart_docinfo_item()
def visit_warning(self, node):
self.visit_admonition(node, 'warning')
def depart_warning(self, node):
self.depart_admonition()
def unimplemented_visit(self, node):
raise NotImplementedError('visiting unimplemented node type: %s'
% node.__class__.__name__)
class SimpleListChecker(nodes.GenericNodeVisitor):
"""
Raise `nodes.SkipNode` if non-simple list item is encountered.
Here "simple" means a list item containing nothing other than a single
paragraph, a simple list, or a paragraph followed by a simple list.
"""
def default_visit(self, node):
raise nodes.NodeFound
def visit_bullet_list(self, node):
pass
def visit_enumerated_list(self, node):
pass
def visit_list_item(self, node):
children = []
for child in node.get_children():
if not isinstance(child, nodes.Invisible):
children.append(child)
if (children and isinstance(children[0], nodes.paragraph)
and (isinstance(children[-1], nodes.bullet_list)
or isinstance(children[-1], nodes.enumerated_list))):
children.pop()
if len(children) <= 1:
return
else:
raise nodes.NodeFound
def visit_paragraph(self, node):
raise nodes.SkipNode
def invisible_visit(self, node):
"""Invisible nodes should be ignored."""
pass
visit_comment = invisible_visit
visit_substitution_definition = invisible_visit
visit_target = invisible_visit
visit_pending = invisible_visit