sphinx.addnodes.toctree

class documentation

class toctree(nodes.General, nodes.Element, translatable):

View In Hierarchy

Node for inserting a "TOC tree".
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):
overrides sphinx.addnodes.translatable.apply_translated_message
Apply translated message.
Parameters
original​_message:strUndocumented
translated​_message:strUndocumented
def extract_original_messages(self):
overrides sphinx.addnodes.translatable.extract_original_messages
Extract translation messages.
Returns
List[str]list of extracted messages or messages generator
def preserve_original_messages(self):
overrides sphinx.addnodes.translatable.preserve_original_messages
Preserve original translatable messages.