AutoCppApi

class documenteer.ext.autocppapi.AutoCppApi(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: SphinxDirective

The autocppapi directive that lists C++ APIs within a namespace, as detected by doxylink.

Attributes Summary

final_argument_whitespace	May the final argument contain whitespace?
has_content	May the directive have content?
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.

Methods Summary

run()

rtype: List[Node]

Attributes Documentation

final_argument_whitespace = False

May the final argument contain whitespace?

has_content = False

May the directive have content?

option_spec = {'doxylink-role': <function unchanged>}

Mapping of option names to validator functions.

optional_arguments = 0

Number of optional arguments after the required arguments.

required_arguments = 1

Number of required directive arguments.

Methods Documentation

run()

Return type:

List[Node]

Execute the directive.