Skip to content

Commit 25d8036

Browse files
mergify[bot]christophfroehlich
mergify[bot]
and
christophfroehlich
authored
Add custom rosdoc2 config for ros2_controllers metapackage (#1100) (#1142)
* Add simple rosdoc2 landing page * Add link to package.xml * Add links to controller docs on control.ros.org * Set check-yaml syntax instead of ignoring (cherry picked from commit 731da8e) Co-authored-by: Christoph Fröhlich <[email protected]>
1 parent 2f8217b commit 25d8036

File tree

6 files changed

+123
-0
lines changed

6 files changed

+123
-0
lines changed

‎.github/workflows/rosdoc2.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: rosdoc2
2+
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
paths:
7+
- ros2_controllers/doc/**
8+
- ros2_controllers/rosdoc2.yaml
9+
- ros2_controllers/package.xml
10+
11+
12+
jobs:
13+
check:
14+
uses: ros-controls/ros2_control_ci/.github/workflows/reusable-rosdoc2.yml@master

‎.pre-commit-config.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ repos:
2626
- id: check-symlinks
2727
- id: check-xml
2828
- id: check-yaml
29+
args: ["--allow-multiple-documents"]
2930
- id: debug-statements
3031
- id: end-of-file-fixer
3132
- id: mixed-line-ending
@@ -104,6 +105,7 @@ repos:
104105
description: Check if copyright notice is available in all files.
105106
entry: ament_copyright
106107
language: system
108+
exclude: .*/conf\.py$
107109

108110
# Docs - RestructuredText hooks
109111
- repo: https://github.com/PyCQA/doc8

‎ros2_controllers/doc/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
# settings will be overridden by rosdoc2, so we add here only custom settings
3+
4+
copyright = "2024, ros2_control development team"
5+
html_logo = "https://control.ros.org/master/_static/logo_ros-controls.png"

‎ros2_controllers/doc/index.rst

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
Welcome to the documentation for ros2_controllers
2+
=================================================
3+
4+
For more information of the ros2_control framework see `control.ros.org <https://control.ros.org/>`__.
5+
6+
.. list-table::
7+
:header-rows: 1
8+
9+
* - Package Name
10+
- Documentation
11+
- API
12+
- ROS Index
13+
* - ackermann_steering_controller
14+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/ackermann_steering_controller/doc/userdoc.html>`__
15+
- `API <http://docs.ros.org/en/rolling/p/ackermann_steering_controller/>`__
16+
- `ROS Index <https://index.ros.org/p/ackermann_steering_controller/>`__
17+
* - admittance_controller
18+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/admittance_controller/doc/userdoc.html>`__
19+
- `API <http://docs.ros.org/en/rolling/p/admittance_controller/>`__
20+
- `ROS Index <https://index.ros.org/p/admittance_controller/>`__
21+
* - bicycle_steering_controller
22+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/bicycle_steering_controller/doc/userdoc.html>`__
23+
- `API <http://docs.ros.org/en/rolling/p/bicycle_steering_controller/>`__
24+
- `ROS Index <https://index.ros.org/p/bicycle_steering_controller/>`__
25+
* - diff_drive_controller
26+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/diff_drive_controller/doc/userdoc.html>`__
27+
- `API <http://docs.ros.org/en/rolling/p/diff_drive_controller/>`__
28+
- `ROS Index <https://index.ros.org/p/diff_drive_controller/>`__
29+
* - effort_controllers
30+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/effort_controllers/doc/userdoc.html>`__
31+
- `API <http://docs.ros.org/en/rolling/p/effort_controllers/>`__
32+
- `ROS Index <https://index.ros.org/p/effort_controllers/>`__
33+
* - force_torque_sensor_broadcaster
34+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/force_torque_sensor_broadcaster/doc/userdoc.html>`__
35+
- `API <http://docs.ros.org/en/rolling/p/force_torque_sensor_broadcaster/>`__
36+
- `ROS Index <https://index.ros.org/p/force_torque_sensor_broadcaster/>`__
37+
* - forward_command_controller
38+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/forward_command_controller/doc/userdoc.html>`__
39+
- `API <http://docs.ros.org/en/rolling/p/forward_command_controller/>`__
40+
- `ROS Index <https://index.ros.org/p/forward_command_controller/>`__
41+
* - imu_sensor_broadcaster
42+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/imu_sensor_broadcaster/doc/userdoc.html>`__
43+
- `API <http://docs.ros.org/en/rolling/p/imu_sensor_broadcaster/>`__
44+
- `ROS Index <https://index.ros.org/p/imu_sensor_broadcaster/>`__
45+
* - joint_state_broadcaster
46+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/joint_state_broadcaster/doc/userdoc.html>`__
47+
- `API <http://docs.ros.org/en/rolling/p/joint_state_broadcaster/>`__
48+
- `ROS Index <https://index.ros.org/p/joint_state_broadcaster/>`__
49+
* - joint_trajectory_controller
50+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/joint_trajectory_controller/doc/userdoc.html>`__
51+
- `API <http://docs.ros.org/en/rolling/p/joint_trajectory_controller/>`__
52+
- `ROS Index <https://index.ros.org/p/joint_trajectory_controller/>`__
53+
* - pid_controller
54+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/pid_controller/doc/userdoc.html>`__
55+
- `API <http://docs.ros.org/en/rolling/p/pid_controller/>`__
56+
- `ROS Index <https://index.ros.org/p/pid_controller/>`__
57+
* - position_controllers
58+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/position_controllers/doc/userdoc.html>`__
59+
- `API <http://docs.ros.org/en/rolling/p/position_controllers/>`__
60+
- `ROS Index <https://index.ros.org/p/position_controllers/>`__
61+
* - range_sensor_broadcaster
62+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/range_sensor_broadcaster/doc/userdoc.html>`__
63+
- `API <http://docs.ros.org/en/rolling/p/range_sensor_broadcaster/>`__
64+
- `ROS Index <https://index.ros.org/p/range_sensor_broadcaster/>`__
65+
* - steering_controllers_library
66+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/steering_controllers_library/doc/userdoc.html>`__
67+
- `API <http://docs.ros.org/en/rolling/p/steering_controllers_library/>`__
68+
- `ROS Index <https://index.ros.org/p/steering_controllers_library/>`__
69+
* - tricycle_controller
70+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/tricycle_controller/doc/userdoc.html>`__
71+
- `API <http://docs.ros.org/en/rolling/p/tricycle_controller/>`__
72+
- `ROS Index <https://index.ros.org/p/tricycle_controller/>`__
73+
* - tricycle_steering_controller
74+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/tricycle_steering_controller/doc/userdoc.html>`__
75+
- `API <http://docs.ros.org/en/rolling/p/tricycle_steering_controller/>`__
76+
- `ROS Index <https://index.ros.org/p/tricycle_steering_controller/>`__
77+
* - velocity_controllers
78+
- `Documentation <https://control.ros.org/master/doc/ros2_controllers/velocity_controllers/doc/userdoc.html>`__
79+
- `API <http://docs.ros.org/en/rolling/p/velocity_controllers/>`__
80+
- `ROS Index <https://index.ros.org/p/velocity_controllers/>`__

‎ros2_controllers/package.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
<license>Apache License 2.0</license>
1010

11+
<url type="website">https://control.ros.org</url>
12+
1113
<buildtool_depend>ament_cmake</buildtool_depend>
1214

1315
<exec_depend>ackermann_steering_controller</exec_depend>

‎ros2_controllers/rosdoc2.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
type: 'rosdoc2 config'
2+
version: 1
3+
4+
---
5+
6+
settings:
7+
# Not generating any documentation of code
8+
generate_package_index: false
9+
always_run_doxygen: false
10+
enable_breathe: false
11+
enable_exhale: false
12+
always_run_sphinx_apidoc: false
13+
14+
builders:
15+
# Configure Sphinx with the location of the docs:
16+
- sphinx: {
17+
name: 'ros2_controllers',
18+
sphinx_sourcedir: 'doc',
19+
output_dir: ''
20+
}

0 commit comments

Comments
 (0)