sphinx.transforms.i18n

module documentation
(source)

Docutils transforms used by Sphinx when reading documents.

Class Locale Replace translatable nodes with their translated doctree.
Class PreserveTranslatableMessages Preserve original translatable messages before translation
Class RemoveTranslatableInline Remove inline nodes used for translation as placeholders.
Function parse_noqa Undocumented
Function publish_msgstr Publish msgstr (single line) into docutils document
Function setup Undocumented
Constant EXCLUDED_PENDING_XREF_ATTRIBUTES Undocumented
Type Variable N Undocumented
Variable logger Undocumented
def parse_noqa(source): (source)

Undocumented

Parameters
source:strUndocumented
Returns
tuple[str, bool]Undocumented
def publish_msgstr(app, source, source_path, source_line, config, settings): (source)

Publish msgstr (single line) into docutils document :param sphinx.application.Sphinx app: sphinx application :param str source: source text :param str source_path: source path for warning indication :param source_line: source line for warning indication :param sphinx.config.Config config: sphinx config :param docutils.frontend.Values settings: docutils settings :return: document :rtype: docutils.nodes.document

Parameters
app:SphinxUndocumented
source:strUndocumented
source_path:strUndocumented
source_line:intUndocumented
config:ConfigUndocumented
settings:AnyUndocumented
Returns
ElementUndocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
EXCLUDED_PENDING_XREF_ATTRIBUTES: tuple[str, ...] = (source)

Undocumented

Value
('refexplicit')
N = (source)

Undocumented

Value
TypeVar('N',
        bound=nodes.Node)
logger = (source)

Undocumented