Open rkent opened 1 month ago
@tfoote are you going to be able to review this?
Concerning "whether we should be adding complexity to support automatically discovering the non-standard layouts/naming conventions vs providing a mechanism to just set this in rosdoc2.yaml":
I feel strongly about:
I don't feel strongly about fixing deviations from those two standards. One example is urdfdom_py, with the source in src/urdf_parser_py (that is, a slightly different name than the actual package name.)
But generally, I don't have a lot of confidence that package authors are going to add rosdoc2.yaml entries to fix minor differences in order to make rosdoc2 happy. I would rather have things "just work", and I am not convinced this adds much complexity to rosdoc2.
But I'll do what you want. If you want me to eliminate the search for misnamed subdirectories then I will.
Fixes #122
The changes made here are:
Tests are included for a variety of cases.
With these changes, the following packages that were not generating output before, now generate a proper output:
These packages that previously failed, now generate html but do not fully document their python:
One python package still fails for another reason:
Many of these could have been made to work previously with the correct specification in rosdoc2.yaml. But philosophically, I think we should try to succeed (with warnings) rather than just abort if the user fails to follow the conventions we expect.