docgen

Documentation

Index

• type ExtraContent
• type Generator
  • func NewGenerator(docsPath, markdownPath, manPath string) *Generator
  • func (g *Generator) Generate(rootCmd *cobra.Command) error

Types

type ExtraContent

type ExtraContent struct {
	Description string
	Examples    string
}

ExtraContent holds additional markdown docs for a command

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator generates documentation from cobra commands

func NewGenerator

func NewGenerator(docsPath, markdownPath, manPath string) *Generator

NewGenerator creates a new documentation generator

func (*Generator) Generate

func (g *Generator) Generate(rootCmd *cobra.Command) error

Generate generates documentation for all commands