sphinx_ros.directives module

class sphinx_ros.directives.RosActionDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Description of a ROS action type.

class sphinx_ros.directives.RosCurrentPackageDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

This directive is just to tell Sphinx that we’re documenting stuff in this package, but links to this package will not lead here.

class sphinx_ros.directives.RosMessageDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Description of a ROS message type.

class sphinx_ros.directives.RosObject(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Description of a general ROS object.

add_object_to_domain_data(fullname, obj_type)

Add the object to the object lists of the ROS domain data.

get_index_text(pkgname, name)

Return the text for the index entry of the object.

get_object_type_prefix()

May return an optional name prefix that defines object type, e.g. ‘msg’ or ‘srv’.

get_signature_prefix(sig)

May return a prefix to put before the object name in the signature.

handle_signature(sig, signode)

Transform a ROS signature into rST nodes.

Return (fully qualified name of the thing, package name if any).

If inside a package, the current package name is handled intelligently: * it is stripped from the displayed name if present * it is added to the full name (return value) if not present

class sphinx_ros.directives.RosPackageDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Directive to mark description of a new package.

class sphinx_ros.directives.RosServiceDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Description of a ROS service type.

class sphinx_ros.directives.RosType(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Super class for messages, services, and actions.