Add custom rosdoc2 config (#199)

* Add basic landing page

* Update website link and add info to README

* Add rosdoc workflow

* Fix workflow filter

* Use master branch of ros2_control_ci repo

.github/workflows/rosdoc2.yml

@@ -0,0 +1,14 @@
+name: rosdoc2
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - doc/**
+      - rosdoc2.yaml
+      - 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

@@ -3,6 +3,8 @@ control_toolbox
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 [![codecov](https://codecov.io/gh/ros-controls/control_toolbox/graph/badge.svg?token=0o4dFzADHj)](https://codecov.io/gh/ros-controls/control_toolbox)
 
+This package contains several C++ classes useful in writing controllers.
+
 See the documentation of [ros2_control](http://control.ros.org) and release infos on [index.ros.org](http://index.ros.org/p/control_toolbox).
 
 ## Build status

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"

doc/index.rst

@@ -0,0 +1,23 @@
+Welcome to the documentation for control_toolbox
+================================================
+
+This package contains several C++ classes useful in writing controllers.
+
+For more information of the ros2_control framework see `control.ros.org <https://control.ros.org/>`__.
+
+
+API documentation
+------------------
+
+.. toctree::
+   :maxdepth: 2
+
+   C++ API <generated/index>
+   Service Definitions <generated/service_definitions>
+
+
+Indices and Search
+==================
+
+* :ref:`genindex`
+* :ref:`search`

package.xml

@@ -8,7 +8,7 @@
 
   <license>BSD-3-Clause</license>
 
-  <url type="website">http://ros.org/wiki/control_toolbox</url>
+  <url type="website">https://control.ros.org</url>
   <url type="bugtracker">https://github.com/ros-controls/control_toolbox/issues</url>
   <url type="repository">https://github.com/ros-controls/control_toolbox/</url>