AbstractDirective

class technote.ext.abstract.AbstractDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: SphinxDirective

The abstract directive for marking up a technote’s summary.

Attributes Summary

final_argument_whitespace	May the final argument contain whitespace?
has_content	May the directive have content?
optional_arguments	Number of optional arguments after the required arguments.
required_arguments	Number of required directive arguments.

Methods Summary

run()

Run the directive on content.

Attributes Documentation

final_argument_whitespace = False

May the final argument contain whitespace?

has_content = True

May the directive have content?

optional_arguments = 0

Number of optional arguments after the required arguments.

required_arguments = 0

Number of required directive arguments.

Methods Documentation

run()

Run the directive on content.

Return type:

list[Node]