ros-infrastructure / rosdoc2

Command-line tool for generating documentation for ROS 2 packages.
Apache License 2.0
29 stars 9 forks source link

add default_config verb to create a default configuration file #45

Closed ottojo closed 4 months ago

ottojo commented 1 year ago

Information about the config file format is hard to find, i think this makes it easier to use.

This adds a verb default_config which just writes the default config file already present in the code to a file, to be customized by the package author.

ottojo commented 4 months ago

Nice to see some activity here, I think package documentation is such an important aspect of ROS with much room for improvement!

I rebased the commit to latest main, and tested it myself as well.

Yadunund commented 4 months ago

Looks like our linters have flagged some formatting issues with the changes proposed. Do you mind addressing them?

ottojo commented 4 months ago

should be fixed! @Yadunund