blark.sphinxdomain.BlarkDirective

class blark.sphinxdomain.BlarkDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]

Bases: ObjectDescription[Tuple[str, str]]

Methods

Attributes

`config`	Reference to the `Config` object.
`doc_field_types`
`domain`
`env`	Reference to the `BuildEnvironment` object.
`final_argument_whitespace`	May the final argument contain whitespace?
`has_content`	May the directive have content?
`indexnode`
`objtype`
`option_spec`	Mapping of option names to validator functions.
`optional_arguments`	Number of optional arguments after the required arguments.
`required_arguments`	Number of required directive arguments.
`name`	The role name actually used in the document.
`rawtext`	A string containing the entire interpreted text input.
`text`	The interpreted text content.
`lineno`	The line number where the interpreted text begins.
`options`	A dictionary of directive options for customization ("role" directive).
`content`	A list of strings, the directive content for customization ("role" directive).

name: str: The role name actually used in the document.

rawtext: str: A string containing the entire interpreted text input.

text: str: The interpreted text content.

lineno: int: The line number where the interpreted text begins.

options: Dict: A dictionary of directive options for customization (“role” directive).

content: List[str]: A list of strings, the directive content for customization (“role” directive).

domain: str | None = None

objtype: str | None = None

indexnode: index = <index: >

has_content: ClassVar[bool] = True: May the directive have content?

required_arguments: ClassVar[int] = 1: Number of required directive arguments.

optional_arguments: ClassVar[int] = 0: Number of optional arguments after the required arguments.

final_argument_whitespace: ClassVar[bool] = True: May the final argument contain whitespace?

doc_field_types: List[Field] = []

option_spec: ClassVar[dict[str, Callable[[str], Any]]] = {'annotation': <function unchanged>, 'canonical': <function unchanged>, 'noblocks': <function flag>, 'noindex': <function flag>, 'noindexentry': <function flag>, 'nolinks': <function flag>, 'nosource': <function flag>}: Mapping of option names to validator functions.