elastic / crd-ref-docs

Generates Kubernetes CRD API reference documentation
Apache License 2.0
104 stars 54 forks source link

Ignore a type but still document its fields when embedded #75

Open justenstall opened 8 months ago

justenstall commented 8 months ago

73 changed (fixed) the behavior of ignoreTypes so that they are actually excluded from the output. I was previously using the ignoreTypes list to ignore types that are only embedded in other structs. The types would not receive their own section/table in the resulting docs, but their fields would still be documented when they were embedded in other structs (with json:",inline"). It would be nice if this use case could be supported in the tool.