BlockDirective
API entry point for setting up a block directive.
Attributes
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- BlockDirective.type
Members list
Value members
Concrete methods
Creates a new directive with the specified name and implementation.
The DirectivePart
can be created by using the methods of the Parts
object.
Creates a new directive with the specified name and implementation.
The DirectivePart
can be created by using the methods of the Parts
object.
Attributes
- name
the name the directive can be used with in reStructuredText markup
- part
the implementation of the directive that can be created by using the combinators of the
Parts
object- Returns:
a new directive that can be registered with the reStructuredText parser
Creates a new directive with the specified name and implementation.
The DirectivePart
can be created by using the methods of the Parts
object. In contrast to the apply
function, this function allows to
depend on the standard block and span parsers. This is necessary if
the directive does both, require a custom parser for arguments or body
and allow for nested directives in those parsers.
Creates a new directive with the specified name and implementation.
The DirectivePart
can be created by using the methods of the Parts
object. In contrast to the apply
function, this function allows to
depend on the standard block and span parsers. This is necessary if
the directive does both, require a custom parser for arguments or body
and allow for nested directives in those parsers.
Attributes
- name
the name the directive can be used with in reStructuredText markup
- part
a function returning the implementation of the directive that can be created by using the combinators of the
Parts
object- Returns:
a new directive that can be registered with the reStructuredText parser