sphinx.transforms.i18n

module documentation

Docutils transforms used by Sphinx when reading documents.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.

Constant	`EXCLUDED_PENDING_XREF_ATTRIBUTES`	Undocumented
Constant	`N`	Undocumented
Variable	`logger`	Undocumented
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	`publish_msgstr`	Publish msgstr (single line) into docutils document
Function	`setup`	Undocumented

EXCLUDED_PENDING_XREF_ATTRIBUTES: tuple[str, ...] =

Undocumented

Value

('refexplicit')

N =

Undocumented

Value

TypeVar('N',
        bound=nodes.Node)

logger =

Undocumented

def publish_msgstr(app, source, source_path, source_line, config, settings):

Publish msgstr (single line) into docutils document

Parameters
app:`Sphinx`	Undocumented
source:`str`	Undocumented
source_path:`str`	Undocumented
source_line:`int`	source line for warning indication
config:`Config`	Undocumented
settings:`Any`	Undocumented
sphinx.application.Sphinx app	sphinx application
str source	source text
str source_path	source path for warning indication
sphinx.config.Config config	sphinx config
docutils.frontend.Values settings	docutils settings
Returns
docutils.nodes.document	document

def setup(app):

Undocumented