sphinx_ros.domain module

This module defines the ROS domain. It defines three object types (messages, services, and actions) and registers the roles and directives in the Sphinx application.

class sphinx_ros.domain.RosDomain(env)[source]

The actual domain class.

add_package(name, deprecated)[source]

Adds a package to the domain data.

Parameters:
  • name (str) – The name of the package
  • deprecated (bool) – Indicates whether the package is deprecated.
Returns:

The unique anchor of the package.
Return type:

str
find_obj(env, pkgname, name, type, searchmode=0)[source]

Find a ROS object for name, perhaps using pkgname.