docs

package

v1.0.0 Latest Latest Go to latest Published: Sep 10, 2023 License: Apache-2.0 Imports: 8 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.

View Source

var Cmd = &cobra.Command{
	Use:    "docs",
	Short:  "Generates documentation files",
	Hidden: true,
	RunE:   Run,
}

Cmd represents the Cobra command for generating documentation files.

func CreateDir(dirPath string) error

CreateDir creates a directory if it doesn't already exist.

func Run(cmd *cobra.Command, _ []string) (err error)

Run is the function executed when the Cobra command is run. It generates the documentation files.

This section is empty.