Add custom rosdoc2 config (#132) (#135)

* Add basic rosdoc2 landing page

* Add rosdoc2 workflow

* Add correct homepage link for ros2

* Remove build_testing

* Use master branch of ros2_control_ci repo

(cherry picked from commit 3b381d1)

Co-authored-by: Christoph Fröhlich <[email protected]>

.github/workflows/rosdoc2.yml

@@ -0,0 +1,14 @@
+name: rosdoc2
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - control_msgs/doc/**
+      - control_msgs/rosdoc2.yaml
+      - control_msgs/package.xml
+
+
+jobs:
+  check:
+    uses: ros-controls/ros2_control_ci/.github/workflows/reusable-rosdoc2.yml@master

.pre-commit-config.yaml

@@ -104,6 +104,7 @@ repos:
         description: Check if copyright notice is available in all files.
         entry: ament_copyright
         language: system
+        exclude: doc/conf.py
 
   # Docs - RestructuredText hooks
   - repo: https://github.com/PyCQA/doc8

README.md

@@ -1,6 +1,8 @@
 control_msgs
 ===========
 
+control_msgs contains base messages and actions useful for controlling robots. It provides representations for controller setpoints and joint and cartesian trajectories.
+
 See [control_msgs documentation](https://index.ros.org/p/control_msgs/) on index.ros.org
 
 

control_msgs/CMakeLists.txt

@@ -47,11 +47,6 @@ set(srv_files
   srv/QueryTrajectoryState.srv
 )
 
-if(BUILD_TESTING)
-  find_package(ament_lint_auto REQUIRED)
-  ament_lint_auto_find_test_dependencies()
-endif()
-
 rosidl_generate_interfaces(${PROJECT_NAME}
   ${action_files}
   ${msg_files}

control_msgs/doc/conf.py

@@ -0,0 +1,5 @@
+# Configuration file for the Sphinx documentation builder.
+# settings will be overridden by rosdoc2, so we add here only custom settings
+
+copyright = "2024, ros2_control development team"
+html_logo = "https://control.ros.org/master/_static/logo_ros-controls.png"

control_msgs/doc/index.rst

@@ -0,0 +1,23 @@
+Welcome to the documentation for control_msgs
+===============================================
+
+control_msgs contains base messages and actions useful for controlling robots. It provides representations for controller setpoints and joint and cartesian trajectories.
+
+For more information of the ros2_control framework see `control.ros.org <https://control.ros.org/>`__.
+
+API documentation
+------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   Action Definitions <generated/action_definitions>
+   Message Definitions <generated/message_definitions>
+   Service Definitions <generated/service_definitions>
+
+
+Indices and Search
+==================
+
+* :ref:`genindex`
+* :ref:`search`

control_msgs/package.xml

@@ -5,14 +5,14 @@
   <version>4.4.0</version>
   <description>
     control_msgs contains base messages and actions useful for
-    controlling robots.  It provides representations for controller
+    controlling robots. It provides representations for controller
     setpoints and joint and cartesian trajectories.
   </description>
   <maintainer email="[email protected]">Bence Magyar</maintainer>
 
   <license>BSD-3-Clause</license>
 
-  <url>http://ros.org/wiki/control_msgs</url>
+  <url type="website">https://control.ros.org</url>
   <author email="[email protected]">Stuart Glaser</author>
 
   <buildtool_depend>ament_cmake</buildtool_depend>