Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CobraCommand ¶
CobraCommand returns a Cobra command used to output a tool's collateral files (markdown docs, bash completion & man pages) The root argument must be the root command for the tool.
Types ¶
type Control ¶
type Control struct {
// OutputDir specifies the directory to output the collateral files
OutputDir string
// EmitManPages controls whether to produce man pages.
EmitManPages bool
// EmitYAML controls whether to produce YAML files.
EmitYAML bool
// EmitBashCompletion controls whether to produce bash completion files.
EmitBashCompletion bool
// EmitMarkdown controls whether to produce mankdown documentation files.
EmitMarkdown bool
// EmitJeyllHTML controls whether to produce Jekyll-friendly HTML documentation files.
EmitJekyllHTML bool
// ManPageInfo provides extra information necessary when emitting man pages.
ManPageInfo doc.GenManHeader
}
Control determines the behavior of the EmitCollateral function
Click to show internal directories.
Click to hide internal directories.