sphinx.util.rst

module documentation

reST helper functions.

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

Constant	`SECTIONING_CHARS`	Undocumented
Constant	`WIDECHARS`	Undocumented
Variable	`docinfo_re`	Undocumented
Variable	`logger`	Undocumented
Variable	`symbols_re`	Undocumented
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.

SECTIONING_CHARS: list[str] =

Undocumented

Value

['=', '-', '~']

WIDECHARS: Dict[str, str] =

Undocumented

Value

defaultdict((lambda : 'WF'))

docinfo_re =

Undocumented

logger =

Undocumented

symbols_re =

Undocumented

def append_epilog(content, epilog):

Append a string to content body as epilog.

@contextmanager
def default_role(docname, name):

Undocumented

def escape(text):

Undocumented

@pass_environment
def heading(env, text, level=1):

Create a heading for level.

def prepend_prolog(content, prolog):

Prepend a string to content body as prolog.

def textwidth(text, widechars='WF'):

Get width of text.