Sphinx extension for autodocs

[christophfroehlich]

I created a sphinx extension, which uses the python scripts of the generate_parameter_library to create parameter documentation automatically.

It can be configured in any rst file by adding the directive

.. generate_parameter_library_details:: ../src/admittance_controller_parameters.yaml

for a detailed parameter list and

.. generate_parameter_library_default:: ../src/admittance_controller_parameters.yaml

for a default ros-params yaml file.

An example with the current rst template

Open tasks:

• ReST template PickNikRobotics/generate_parameter_library#119
• implement _map Markdown: __map_ parameters PickNikRobotics/generate_parameter_library#118
• install the library within the github workflow, via pip or manually?
• use local paths instead of global ones starting with doc/

[destogl]

@christophfroehlich should we merge this or wait that we can also generate __map__ parameters?

[christophfroehlich]

I think we can merge it, because ideally we don't have to change this extension but only wait for a new release of the generate_parameter_library. And we already can use it for yaml-files without __map_s

[christophfroehlich]

Damn, the action fails on the master branch. I'll have a look how to fix that

[christophfroehlich]

@Mergifyio backport humble

[mergify]

backport humble

✅ Backports have been created

• #117 Sphinx extension for autodocs (backport #97) has been created for branch humble but encountered conflicts