Skip to content

Commit 159087e

Browse files
christophfroehlichchristophfroehlich
authored
Add API page (#268)
1 parent 0433b9d commit 159087e

File tree

3 files changed

+158
-1
lines changed

3 files changed

+158
-1
lines changed

‎conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
"sphinx_copybutton",
8686
"generate_parameter_library",
8787
'sphinx_tabs.tabs',
88-
"sphinx.ext.autosectionlabel",
88+
"sphinx.ext.autosectionlabel"
8989
]
9090

9191
# Make sure the target is unique

‎doc/api/api.rst

+154
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
2+
=================
3+
API Documentation
4+
=================
5+
6+
Here you can find links to the API documentation published on docs.ros.org
7+
8+
ros2_control
9+
*************
10+
11+
A documentation for the whole repository is parsed by doxygen and can be found `here <../api/index.html>`_
12+
13+
.. list-table::
14+
:header-rows: 1
15+
16+
* - Package Name
17+
- API
18+
- ROS Index
19+
* - controller_interface
20+
- `API <http://docs.ros.org/en/{DISTRO}/p/controller_interface/>`__
21+
- `ROS Index <https://index.ros.org/p/controller_interface/>`__
22+
* - controller_manager
23+
- `API <http://docs.ros.org/en/{DISTRO}/p/controller_manager/>`__
24+
- `ROS Index <https://index.ros.org/p/controller_manager/>`__
25+
* - controller_manager_msgs
26+
- `API <http://docs.ros.org/en/{DISTRO}/p/controller_manager_msgs/>`__
27+
- `ROS Index <https://index.ros.org/p/controller_manager_msgs/>`__
28+
* - hardware_interface
29+
- `API <http://docs.ros.org/en/{DISTRO}/p/hardware_interface/>`__
30+
- `ROS Index <https://index.ros.org/p/hardware_interface/>`__
31+
* - ros2_control_test_assets
32+
- `API <http://docs.ros.org/en/{DISTRO}/p/ros2_control_test_assets/>`__
33+
- `ROS Index <https://index.ros.org/p/ros2_control_test_assets/>`__
34+
* - transmission_interface
35+
- `API <http://docs.ros.org/en/{DISTRO}/p/transmission_interface/>`__
36+
- `ROS Index <https://index.ros.org/p/transmission_interface/>`__
37+
38+
ros2_controllers
39+
****************
40+
41+
.. list-table::
42+
:header-rows: 1
43+
44+
* - Package Name
45+
- API
46+
- ROS Index
47+
* - ackermann_steering_controller
48+
- `API <http://docs.ros.org/en/{DISTRO}/p/ackermann_steering_controller/>`__
49+
- `ROS Index <https://index.ros.org/p/ackermann_steering_controller/>`__
50+
* - admittance_controller
51+
- `API <http://docs.ros.org/en/{DISTRO}/p/admittance_controller/>`__
52+
- `ROS Index <https://index.ros.org/p/admittance_controller/>`__
53+
* - bicycle_steering_controller
54+
- `API <http://docs.ros.org/en/{DISTRO}/p/bicycle_steering_controller/>`__
55+
- `ROS Index <https://index.ros.org/p/bicycle_steering_controller/>`__
56+
* - diff_drive_controller
57+
- `API <http://docs.ros.org/en/{DISTRO}/p/diff_drive_controller/>`__
58+
- `ROS Index <https://index.ros.org/p/diff_drive_controller/>`__
59+
* - effort_controllers
60+
- `API <http://docs.ros.org/en/{DISTRO}/p/effort_controllers/>`__
61+
- `ROS Index <https://index.ros.org/p/effort_controllers/>`__
62+
* - force_torque_sensor_broadcaster
63+
- `API <http://docs.ros.org/en/{DISTRO}/p/force_torque_sensor_broadcaster/>`__
64+
- `ROS Index <https://index.ros.org/p/force_torque_sensor_broadcaster/>`__
65+
* - forward_command_controller
66+
- `API <http://docs.ros.org/en/{DISTRO}/p/forward_command_controller/>`__
67+
- `ROS Index <https://index.ros.org/p/forward_command_controller/>`__
68+
* - imu_sensor_broadcaster
69+
- `API <http://docs.ros.org/en/{DISTRO}/p/imu_sensor_broadcaster/>`__
70+
- `ROS Index <https://index.ros.org/p/imu_sensor_broadcaster/>`__
71+
* - joint_state_broadcaster
72+
- `API <http://docs.ros.org/en/{DISTRO}/p/joint_state_broadcaster/>`__
73+
- `ROS Index <https://index.ros.org/p/joint_state_broadcaster/>`__
74+
* - joint_trajectory_controller
75+
- `API <http://docs.ros.org/en/{DISTRO}/p/joint_trajectory_controller/>`__
76+
- `ROS Index <https://index.ros.org/p/joint_trajectory_controller/>`__
77+
* - pid_controller
78+
- `API <http://docs.ros.org/en/{DISTRO}/p/pid_controller/>`__
79+
- `ROS Index <https://index.ros.org/p/pid_controller/>`__
80+
* - position_controllers
81+
- `API <http://docs.ros.org/en/{DISTRO}/p/position_controllers/>`__
82+
- `ROS Index <https://index.ros.org/p/position_controllers/>`__
83+
* - range_sensor_broadcaster
84+
- `API <http://docs.ros.org/en/{DISTRO}/p/range_sensor_broadcaster/>`__
85+
- `ROS Index <https://index.ros.org/p/range_sensor_broadcaster/>`__
86+
* - steering_controllers_library
87+
- `API <http://docs.ros.org/en/{DISTRO}/p/steering_controllers_library/>`__
88+
- `ROS Index <https://index.ros.org/p/steering_controllers_library/>`__
89+
* - tricycle_controller
90+
- `API <http://docs.ros.org/en/{DISTRO}/p/tricycle_controller/>`__
91+
- `ROS Index <https://index.ros.org/p/tricycle_controller/>`__
92+
* - tricycle_steering_controller
93+
- `API <http://docs.ros.org/en/{DISTRO}/p/tricycle_steering_controller/>`__
94+
- `ROS Index <https://index.ros.org/p/tricycle_steering_controller/>`__
95+
* - velocity_controllers
96+
- `API <http://docs.ros.org/en/{DISTRO}/p/velocity_controllers/>`__
97+
- `ROS Index <https://index.ros.org/p/velocity_controllers/>`__
98+
99+
control_msgs
100+
*************
101+
102+
.. list-table::
103+
:header-rows: 1
104+
105+
* - Package Name
106+
- API
107+
- ROS Index
108+
* - control_msgs
109+
- `API <http://docs.ros.org/en/{DISTRO}/p/control_msgs/>`__
110+
- `ROS Index <https://index.ros.org/p/control_msgs/>`__
111+
112+
control_toolbox
113+
***************
114+
115+
.. list-table::
116+
:header-rows: 1
117+
118+
* - Package Name
119+
- API
120+
- ROS Index
121+
* - control_toolbox
122+
- `API <http://docs.ros.org/en/{DISTRO}/p/control_toolbox/>`__
123+
- `ROS Index <https://index.ros.org/p/control_toolbox/>`__
124+
125+
126+
kinematics_interface
127+
********************
128+
129+
.. list-table::
130+
:header-rows: 1
131+
132+
* - Package Name
133+
- API
134+
- ROS Index
135+
* - kinematics_interface
136+
- `API <http://docs.ros.org/en/{DISTRO}/p/kinematics_interface/>`__
137+
- `ROS Index <https://index.ros.org/p/kinematics_interface/>`__
138+
* - kinematics_interface_kdl
139+
- `API <http://docs.ros.org/en/{DISTRO}/p/kinematics_interface_kdl/>`__
140+
- `ROS Index <https://index.ros.org/p/kinematics_interface_kdl/>`__
141+
142+
143+
realtime_tools
144+
**************
145+
146+
.. list-table::
147+
:header-rows: 1
148+
149+
* - Package Name
150+
- API
151+
- ROS Index
152+
* - control_msgs
153+
- `API <http://docs.ros.org/en/{DISTRO}/p/realtime_tools/>`__
154+
- `ROS Index <https://index.ros.org/p/velocity_controllers/>`__

‎index.rst

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Welcome to the ros2_control documentation!
1313
doc/ros2_control/ros2controlcli/doc/userdoc.rst
1414
doc/simulators/simulators.rst
1515
doc/migration/migration.rst
16+
doc/api/api.rst
1617
doc/supported_robots/supported_robots.rst
1718
doc/resources/resources.rst
1819
doc/contributing/contributing.rst
@@ -35,6 +36,7 @@ The ros2_control framework consists of the following Github repositories:
3536
* `control_toolbox`_ - some widely-used control theory implementations (e.g. PID) used by controllers;
3637
* `realtime_tools`_ - general toolkit for realtime support, e.g., realtime buffers and publishers;
3738
* `control_msgs`_ - common messages.
39+
* `kinematics_interface`_ - for using C++ kinematics frameworks.
3840

3941

4042
Additionally, there are following (unreleased) packages are relevant for getting-started and project management:
@@ -72,6 +74,7 @@ General discussions
7274
.. _control_msgs: https://github.com/ros-controls/control_msgs
7375
.. _realtime_tools: https://github.com/ros-controls/realtime_tools
7476
.. _control_toolbox: https://github.com/ros-controls/control_toolbox
77+
.. _kinematics_interface: https://github.com/ros-controls/kinematics_interface
7578
.. _ros2_control_demos: https://github.com/ros-controls/ros2_control_demos
7679
.. _controller_manager_msgs: https://github.com/ros-controls/ros2_control/tree/{REPOS_FILE_BRANCH}/controller_manager_msgs
7780
.. _Controller Manager: https://github.com/ros-controls/ros2_control/blob/{REPOS_FILE_BRANCH}/controller_manager/src/controller_manager.cpp

0 commit comments

Comments
 (0)