sphinx.util.docutils.SphinxTranslator

class documentation

class SphinxTranslator(nodes.NodeVisitor):

Known subclasses: sphinx.writers.html.HTMLTranslator, sphinx.writers.html5.HTML5Translator, sphinx.writers.latex.LaTeXTranslator, sphinx.writers.manpage.ManualPageTranslator, sphinx.writers.texinfo.TexinfoTranslator, sphinx.writers.text.TextTranslator

View In Hierarchy

A base class for Sphinx translators.

This class adds a support for visitor/departure method for super node class if visitor/departure method for node class is not found.

It also provides helper methods for Sphinx translators.

Note

The subclasses of this class might not work with docutils. This class is strongly coupled with Sphinx.

Method __init__ Undocumented
Method dispatch​_departure Dispatch node to appropriate departure method. The priority of departure method is:
Method dispatch​_visit Dispatch node to appropriate visitor method. The priority of visitor method is:
Method unknown​_visit Undocumented
Instance Variable builder Undocumented
Instance Variable config Undocumented
Instance Variable settings Undocumented
def __init__(self, document, builder):
overridden in sphinx.writers.html.HTMLTranslator, sphinx.writers.html5.HTML5Translator, sphinx.writers.latex.LaTeXTranslator, sphinx.writers.manpage.ManualPageTranslator, sphinx.writers.texinfo.TexinfoTranslator, sphinx.writers.text.TextTranslator

Undocumented

Parameters
document:nodes.documentUndocumented
builder:BuilderUndocumented
def dispatch_departure(self, node):

Dispatch node to appropriate departure method. The priority of departure method is:

  1. self.depart_{node_class}()
  2. self.depart_{super_node_class}()
  3. self.unknown_departure()
Parameters
node:NodeUndocumented
def dispatch_visit(self, node):

Dispatch node to appropriate visitor method. The priority of visitor method is:

  1. self.visit_{node_class}()
  2. self.visit_{super_node_class}()
  3. self.unknown_visit()
Parameters
node:NodeUndocumented
def unknown_visit(self, node):

Undocumented

Parameters
node:NodeUndocumented
builder =
overridden in sphinx.writers.html.HTMLTranslator, sphinx.writers.html5.HTML5Translator, sphinx.writers.latex.LaTeXTranslator, sphinx.writers.texinfo.TexinfoTranslator, sphinx.writers.text.TextTranslator

Undocumented

config =

Undocumented

settings =

Undocumented