sphinx.util.rst

module documentation
(source)

reST helper functions.

Function append_epilog Append a string to content body as epilog.
Function default_role Undocumented
Function escape Undocumented
Function heading Create a heading for *level*.
Function prepend_prolog Prepend a string to content body as prolog.
Function textwidth Get width of text.
Constant SECTIONING_CHARS Undocumented
Constant WIDECHARS Undocumented
Variable docinfo_re Undocumented
Variable logger Undocumented
Variable symbols_re Undocumented
def append_epilog(content, epilog): (source)

Append a string to content body as epilog.

Parameters
content:StringListUndocumented
epilog:strUndocumented
@contextmanager
def default_role(docname, name): (source)

Undocumented

Parameters
docname:strUndocumented
name:strUndocumented
Returns
Generator[None, None, None]Undocumented
def escape(text): (source)

Undocumented

Parameters
text:strUndocumented
Returns
strUndocumented
@pass_environment
def heading(env, text, level=1): (source)

Create a heading for *level*.

Parameters
env:EnvironmentUndocumented
text:strUndocumented
level:intUndocumented
Returns
strUndocumented
def prepend_prolog(content, prolog): (source)

Prepend a string to content body as prolog.

Parameters
content:StringListUndocumented
prolog:strUndocumented
def textwidth(text, widechars='WF'): (source)

Get width of text.

Parameters
text:strUndocumented
widechars:strUndocumented
Returns
intUndocumented
SECTIONING_CHARS: list[str] = (source)

Undocumented

Value
['=', '-', '~']
WIDECHARS: dict[str, str] = (source)

Undocumented

Value
defaultdict((lambda : 'WF'))
docinfo_re = (source)

Undocumented

logger = (source)

Undocumented

symbols_re = (source)

Undocumented