diff --git a/.github/workflows/rosdoc2.yml b/.github/workflows/rosdoc2.yml new file mode 100644 index 0000000..bed9cf9 --- /dev/null +++ b/.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 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c6de5ef..8d1306a 100644 --- a/.pre-commit-config.yaml +++ b/.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 diff --git a/README.md b/README.md index 846c4a7..1d0e3a4 100644 --- a/README.md +++ b/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 diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..b6134e9 --- /dev/null +++ b/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" diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..b4c4448 --- /dev/null +++ b/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 `__. + + +API documentation +------------------ + +.. toctree:: + :maxdepth: 2 + + C++ API + Service Definitions + + +Indices and Search +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/package.xml b/package.xml index b47371a..c523d85 100644 --- a/package.xml +++ b/package.xml @@ -8,7 +8,7 @@ BSD-3-Clause - http://ros.org/wiki/control_toolbox + https://control.ros.org https://github.com/ros-controls/control_toolbox/issues https://github.com/ros-controls/control_toolbox/