docutils.parsers.rst.roles Namespace Reference

Classes
class	CustomRole
class	GenericRole

Functions
	role (role_name, language_module, lineno, reporter)
	register_canonical_role (name, role_fn)
	register_local_role (name, role_fn)
	set_implicit_options (role_fn)
	register_generic_role (canonical_name, node_class)
	generic_custom_role (role, rawtext, text, lineno, inliner, options=None, content=None)
	pep_reference_role (role, rawtext, text, lineno, inliner, options=None, content=None)
	Define and register the standard roles:
	rfc_reference_role (role, rawtext, text, lineno, inliner, options=None, content=None)
	raw_role (role, rawtext, text, lineno, inliner, options=None, content=None)
	code_role (role, rawtext, text, lineno, inliner, options=None, content=None)
	math_role (role, rawtext, text, lineno, inliner, options=None, content=None)
	unimplemented_role (role, rawtext, text, lineno, inliner, options=None, content=None)
	Register roles that are currently unimplemented.
	set_classes (options)
	normalized_role_options (options)

Variables
str	DEFAULT_INTERPRETED_ROLE = 'title-reference'
dict	_role_registry = {}
dict	_roles = {}
	options

Detailed Description

This module defines standard interpreted text role functions, a registry for
interpreted text roles, and an API for adding to and retrieving from the
registry. See also `Creating reStructuredText Interpreted Text Roles`__.

__ https://docutils.sourceforge.io/docs/ref/rst/roles.html


The interface for interpreted role functions is as follows::

    def role_fn(name, rawtext, text, lineno, inliner,
                options=None, content=None):
        code...

    # Set function attributes for customization:
    role_fn.options = ...
    role_fn.content = ...

Parameters:

- ``name`` is the local name of the interpreted text role, the role name
  actually used in the document.

- ``rawtext`` is a string containing the entire interpreted text construct.
  Return it as a ``problematic`` node linked to a system message if there is a
  problem.

- ``text`` is the interpreted text content, with backslash escapes converted
  to nulls (``\x00``).

- ``lineno`` is the line number where the text block containing the
  interpreted text begins.

- ``inliner`` is the Inliner object that called the role function.
  It defines the following useful attributes: ``reporter``,
  ``problematic``, ``memo``, ``parent``, ``document``.

- ``options``: A dictionary of directive options for customization, to be
  interpreted by the role function.  Used for additional attributes for the
  generated elements and other functionality.

- ``content``: A list of strings, the directive content for customization
  ("role" directive).  To be interpreted by the role function.

Function attributes for customization, interpreted by the "role" directive:

- ``options``: A dictionary, mapping known option names to conversion
  functions such as `int` or `float`.  ``None`` or an empty dict implies no
  options to parse.  Several directive option conversion functions are defined
  in the `directives` module.

  All role functions implicitly support the "class" option, unless disabled
  with an explicit ``{'class': None}``.

- ``content``: A boolean; true if content is allowed.  Client code must handle
  the case where content is required but not supplied (an empty content list
  will be supplied).

Note that unlike directives, the "arguments" function attribute is not
supported for role customization.  Directive arguments are handled by the
"role" directive itself.

Interpreted role functions return a tuple of two values:

- A list of nodes which will be inserted into the document tree at the
  point where the interpreted role was encountered (can be an empty
  list).

- A list of system messages, which will be inserted into the document tree
  immediately after the end of the current inline block (can also be empty).

Function Documentation

generic_custom_role()

docutils.parsers.rst.roles.generic_custom_role	(		role,
			rawtext,
			text,
			lineno,
			inliner,
			options = None,
			content = None
	)

Base for custom roles if no other base role is specified.

normalized_role_options()

docutils.parsers.rst.roles.normalized_role_options

(

options

)

Return normalized dictionary of role options.

* ``None`` is replaced by an empty dictionary.
* The key 'class' is renamed to 'classes'.

register_canonical_role()

docutils.parsers.rst.roles.register_canonical_role	(		name,
			role_fn
	)

Register an interpreted text role by its canonical name.

:Parameters:
  - `name`: The canonical name of the interpreted role.
  - `role_fn`: The role function.  See the module docstring.

register_generic_role()

docutils.parsers.rst.roles.register_generic_role	(		canonical_name,
			node_class
	)

For roles which simply wrap a given `node_class` around the text.

register_local_role()

docutils.parsers.rst.roles.register_local_role	(		name,
			role_fn
	)

Register an interpreted text role by its local or language-dependent name.

:Parameters:
  - `name`: The local or language-dependent name of the interpreted role.
  - `role_fn`: The role function.  See the module docstring.

role()

docutils.parsers.rst.roles.role	(		role_name,
			language_module,
			lineno,
			reporter
	)

Locate and return a role function from its language-dependent name, along
with a list of system messages.

If the role is not found in the current language, check English. Return a
2-tuple: role function (``None`` if the named role cannot be found) and a
list of system messages.

set_classes()

docutils.parsers.rst.roles.set_classes

(

options

)

Deprecated. Obsoleted by ``normalized_role_options()``.

set_implicit_options()

docutils.parsers.rst.roles.set_implicit_options

(

role_fn

)

Add customization options to role functions, unless explicitly set or
disabled.