search

ros-infrastructure / rosdoc_lite

A light-weight version of rosdoc that does not rely on ROS infrastructure for crawling packages.
10 stars 31 forks source link

Add option "required" to builder configs which will cause rosdoc_lite to fail if the builder fails. #106

Closed peci1 closed 1 year ago

peci1 commented 1 year ago

Resolves #63.

Each builder gets an optional parameter required. If set to True, rosdoc_lite will fail if the builder failed. However, all other builders are given the option to finish their run before rosdoc_lite is exited, so that as much documentation is generated as possible.

I've set the parameter to default to False so that the feature is opt-in. This should leave all existing packages without a change, but new packages are allowed to opt in. We could also change the documentation to consistently add required: True in the examples, with the note that it can be turned off.

@tfoote Would this be a good approach?

peci1 commented 1 year ago

Thanks for the review. I've updated the code docs a bit. However, the main documentation is on the Wiki, which I'll update when this PR is merged.

peci1 commented 1 year ago

With no outsanding PRs, would it be a good time to make a release?

peci1 commented 1 year ago

Wiki docs updated: http://wiki.ros.org/action/info/rosdoc_lite?action=diff&rev2=24&rev1=23 .