Add extra -c flag for specifying rosdoc.yaml file which is out of package dir.

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 extra -c flag for specifying rosdoc.yaml file which is out of package dir. #60

Closed kamiccolo closed 1 year ago

kamiccolo commented 8 years ago

Motivation: versatility which allows generating different versions of documentation for the same package. Use-cases:

rosdoc.yaml templates filled during build
generating multiple versions of documentation, maybe even using different engines or other options

If flag is not specified --- fallback on the file exported in manifest and/or PKG_DIR/package.xml

jack-oquin commented 8 years ago

Looks reasonable to me.

It's a fairly large change. How confident are you of the testing?

kamiccolo commented 8 years ago

Another way would probably just be allowing multiple <rosdoc config="rosdoc.yaml" /> entries to be parsed. Still, generating configuration during build wouldn't be feasible...

Something like this:

<export>
    <rosdoc config="rosdoc.yaml" />
    <rosdoc config="rosdoc_headers_only" />
    <rosdoc config="rosdoc_epydoc" />
</export>

etc.

Agh, right, crafting some tests at the moment.

tfoote commented 1 year ago

As this is noteably out of date and conflicts I'm going to close this. If it's still of interest please comment back or open a new PR with the update.