docs

package
v0.0.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2020 License: GPL-3.0 Imports: 18 Imported by: 0

Documentation

Overview

Package docs handles the automatic generation of documentation for the command line interface and configuration format.

Index

Constants

This section is empty.

Variables

View Source
var ErrRootTypeNotFound = errors.New("root type config.Project not found")

ErrRootTypeNotFound indicates an error when the root type of the configuration file could not be found in the project source.

Functions

func CmdConfig

func CmdConfig() *cobra.Command

CmdConfig returns the cobra.Command for the man subcommand.

func CmdMan

func CmdMan() *cobra.Command

CmdMan returns the cobra.Command for the man subcommand.

func CmdMarkdown

func CmdMarkdown() *cobra.Command

CmdMarkdown returns the cobra.Command for the man subcommand.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL