Add option "required" to builder configs which will cause rosdoc_lite to fail if the builder fails. #106
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tfoote
requested changes
May 1, 2023
There was a problem hiding this comment.
Overall this looks like a good way to enable this.
I had one code comment. The documentation for generate_docs should be extended to document the potential exception in the doc block.
And I'd like to see a little bit more added to the documentation to document this capability. But overall this looks like a great addition.
Co-authored-by: Tully Foote <tully.foote@gmail.com>
|
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. |
tfoote
approved these changes
Jun 23, 2023
|
With no outsanding PRs, would it be a good time to make a release? |
|
Wiki docs updated: http://wiki.ros.org/action/info/rosdoc_lite?action=diff&rev2=24&rev1=23 . |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: Truein the examples, with the note that it can be turned off.@tfoote Would this be a good approach?