blark.sphinxdomain.GvlDirective

class blark.sphinxdomain.GvlDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: BlarkDirectiveWithDeclarations

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.
signature_prefix
obj
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).

obj: GlobalVariableSummary

signature_prefix: ClassVar[str] = 'GVL'