Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func LoadCRDs ¶
func LoadCRDs(dirpath string) ([]*apiextensions.CustomResourceDefinition, error)
LoadCRDs loads all CustomResourceDefinition resources from a directory (glob)
Types ¶
type FieldModel ¶
type FieldModel struct {
Name string
Type string
TypeKey *string
Description string
Required bool
Schema apiextensions.JSONSchemaProps
}
type GroupModel ¶
type Model ¶
type Model struct {
Metadata PageMetadata `yaml:"metadata"`
Groups []*GroupModel `yaml:"groups"`
}
type ModelBuilder ¶
type ModelBuilder struct {
Model *Model
Strict bool
TemplatesDirOrFile string
OutputFilepath string
// contains filtered or unexported fields
}
ModelBuilder is the entry point for docs generation
func NewModelBuilder ¶
func (*ModelBuilder) Add ¶
func (b *ModelBuilder) Add(crd *apiextensions.CustomResourceDefinition) error
Add adds a CustomResourceDefinition to the model
func (*ModelBuilder) Output ¶
func (b *ModelBuilder) Output() error
Output writes markdown to the output direcory
type PageMetadata ¶
Click to show internal directories.
Click to hide internal directories.