sphinx.addnodes.translatable

class documentation

class translatable(nodes.Node): (source)

Known subclasses: sphinx.addnodes.toctree

Node which supports translation. The translation goes forward with following steps: 1. Preserve original translatable messages 2. Apply translated messages from message catalog 3. Extract preserved messages (for gettext builder) The translatable nodes MUST preserve original messages. And these messages should not be overridden at applying step. Because they are used at final step; extraction.

Method	`apply_translated_message`	Apply translated message.
Method	`extract_original_messages`	Extract translation messages.
Method	`preserve_original_messages`	Preserve original translatable messages.

def apply_translated_message(self, original_message, translated_message): (source) ¶

overridden in sphinx.addnodes.toctree

Apply translated message.

Parameters
original_message:`str`	Undocumented
translated_message:`str`	Undocumented

def extract_original_messages(self): (source) ¶

overridden in sphinx.addnodes.toctree

Extract translation messages. :returns: list of extracted messages or messages generator

Returns
`Sequence[str]`	Undocumented

def preserve_original_messages(self): (source) ¶

overridden in sphinx.addnodes.toctree

Preserve original translatable messages.