From 0f77bc37f40a180608d44968f9eda543fd2210ea Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christoph=20Fr=C3=B6hlich?=
 <christophfroehlich@users.noreply.github.com>
Date: Mon, 29 Apr 2024 14:51:44 +0200
Subject: [PATCH] [PID] Add example yaml to docs (#951)

* Add default yaml to docs

* Add examples from test folder
---
 pid_controller/doc/userdoc.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/pid_controller/doc/userdoc.rst b/pid_controller/doc/userdoc.rst
index 5570f523fe..fc94357ab3 100644
--- a/pid_controller/doc/userdoc.rst
+++ b/pid_controller/doc/userdoc.rst
@@ -83,4 +83,21 @@ Parameters
 
 The PID controller uses the `generate_parameter_library <https://github.com/PickNikRobotics/generate_parameter_library>`_ to handle its parameters.
 
+List of parameters
+=========================
 .. generate_parameter_library_details:: ../src/pid_controller.yaml
+
+
+An example parameter file
+=========================
+
+
+An example parameter file for this controller can be found in `the test folder (standalone) <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/pid_controller/test/pid_controller_params.yaml>`_:
+
+.. literalinclude:: ../test/pid_controller_params.yaml
+   :language: yaml
+
+or as `preceding controller <https://github.com/ros-controls/ros2_controllers/blob/{REPOS_FILE_BRANCH}/pid_controller/test/pid_controller_preceding_params.yaml>`_:
+
+.. literalinclude:: ../test/pid_controller_preceding_params.yaml
+   :language: yaml