Add repository README.md to generate_parameter_library package docs

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:

generate_parameter_library/README.md

@@ -0,0 +1 @@
+../README.md

generate_parameter_library/doc/conf.py

@@ -0,0 +1,2 @@
+# Enable using markdown headings as anchors (used in README)
+myst_heading_anchors = 3

generate_parameter_library/package.xml

@@ -31,5 +31,6 @@
 
   <export>
     <build_type>ament_cmake</build_type>
+    <rosdoc2>rosdoc2.yaml</rosdoc2>
   </export>
 </package>

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