Add support for options to control documentation output and search path #47
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.
I've added the following options
-p : too pass a search path to the command line tool, useful when building and testing against helm charts in different locations
s: values.yaml fields with no descriptive comments are omitted from the documentation produced. Reasoning: We have large umbrella helm charts; the values.yaml includes third party subcharts and some internal "development" fields; we need control over which fields are documented.
c: prevents objects / lists being documented in the default field. We have deep nested objects in values.yaml. We want to be able to add documentation string for a top level object (and some of its children) without the entire (large, complex) object visible in the default column in the documentation. With this option, a blank default field (
""
) is producedThe long names of these fields are not easy to pick - alternative suggestions welcome.
Added some tests for the new options