docgen

package

v0.0.0-...-a6e1d60 Latest Latest Go to latest Published: Aug 27, 2018 License: Apache-2.0 Imports: 23 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Generate(k8sLibPath, docsPath string, groups ...string) error

Generate generates the docs

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

Docgen is a documentation generator for k8s.

func New(node ast.Node, docsPath string, groups ...string) (*Docgen, error)

New creates an instance of Docgen.

func (dg *Docgen) Generate() error

Generate generates documentation.

Path	Synopsis
template