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: 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 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 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: {}