sphinx.addnodes.toctree

class documentation

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

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): (source)
overrides sphinx.addnodes.translatable.apply_translated_message

Apply translated message.

Parameters
original_message:strUndocumented
translated_message:strUndocumented
def extract_original_messages(self): (source)
overrides sphinx.addnodes.translatable.extract_original_messages

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

Returns
list[str]Undocumented
def preserve_original_messages(self): (source)
overrides sphinx.addnodes.translatable.preserve_original_messages

Preserve original translatable messages.