From 615eca799295a4ccaaa85dd849b9a44c11b9721c Mon Sep 17 00:00:00 2001 From: Jonas Otto Date: Sun, 30 Nov 2025 15:39:00 +0100 Subject: [PATCH 1/4] README: make links to examples absolute so they work when the README is imported from elsewhere --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 70a0364a..7a55d03f 100644 --- a/README.md +++ b/README.md @@ -471,7 +471,7 @@ force_torque_broadcaster_controller: ### Example Project -See [cpp example](example/) or [python example](example_python/) for complete examples of how to use the generate_parameter_library. +See [cpp example](https://github.com/PickNikRobotics/generate_parameter_library/tree/main/example) or [python example](https://github.com/PickNikRobotics/generate_parameter_library/tree/main/example_python) for complete examples of how to use the generate_parameter_library. ### Generated code output The generated code primarily consists of two major components: From fc91e6630deca4eee10cec55585364b08c3b60b7 Mon Sep 17 00:00:00 2001 From: Jonas Otto Date: Sun, 30 Nov 2025 15:39:34 +0100 Subject: [PATCH 2/4] add rosdoc2 config to silence warning about no python modules found --- generate_parameter_library/package.xml | 1 + generate_parameter_library/rosdoc2.yaml | 10 ++++++++++ 2 files changed, 11 insertions(+) create mode 100644 generate_parameter_library/rosdoc2.yaml diff --git a/generate_parameter_library/package.xml b/generate_parameter_library/package.xml index d1311a84..941919fc 100644 --- a/generate_parameter_library/package.xml +++ b/generate_parameter_library/package.xml @@ -31,5 +31,6 @@ ament_cmake + rosdoc2.yaml diff --git a/generate_parameter_library/rosdoc2.yaml b/generate_parameter_library/rosdoc2.yaml new file mode 100644 index 00000000..4f9d5d1e --- /dev/null +++ b/generate_parameter_library/rosdoc2.yaml @@ -0,0 +1,10 @@ +type: "rosdoc2 config" +version: 1 + +--- +settings: { + # Prevent rosdoc2 from infering this is a python package because it depends on ament_cmake_python + never_run_sphinx_apidoc: true, + } +builders: + - sphinx: {} From dee579163ef0705f5646895aba58f908d00c54e3 Mon Sep 17 00:00:00 2001 From: Jonas Otto Date: Sun, 30 Nov 2025 15:40:36 +0100 Subject: [PATCH 3/4] enable markdown heading anchors in sphinx docs --- generate_parameter_library/doc/conf.py | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 generate_parameter_library/doc/conf.py diff --git a/generate_parameter_library/doc/conf.py b/generate_parameter_library/doc/conf.py new file mode 100644 index 00000000..7d55c9fe --- /dev/null +++ b/generate_parameter_library/doc/conf.py @@ -0,0 +1,2 @@ +# Enable using markdown headings as anchors (used in README) +myst_heading_anchors = 3 From 876afd33082d40fd5eb9c22350a7e4e268a9e9df Mon Sep 17 00:00:00 2001 From: Jonas Otto Date: Sun, 30 Nov 2025 15:41:06 +0100 Subject: [PATCH 4/4] add symlink to repo README from generate_parameter_library package --- generate_parameter_library/README.md | 1 + 1 file changed, 1 insertion(+) create mode 120000 generate_parameter_library/README.md diff --git a/generate_parameter_library/README.md b/generate_parameter_library/README.md new file mode 120000 index 00000000..32d46ee8 --- /dev/null +++ b/generate_parameter_library/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file