README
¶
Documentation generation
Options
DisableAutoGenTag
You may set cmd.DisableAutoGenTag = true
to entirely remove the auto generated string "Auto generated by spf13/cobra..."
from any documentation source.
Documentation
¶
Index ¶
- func GenMarkdown(cmd *cobra.Command, w io.Writer) error
- func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error
- func GenMarkdownTree(cmd *cobra.Command, dir string) error
- func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error
- func GenReST(cmd *cobra.Command, w io.Writer) error
- func GenReSTCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string, string) string) error
- func GenReSTTree(cmd *cobra.Command, dir string) error
- func GenReSTTreeCustom(cmd *cobra.Command, dir string, filePrepender func(string) string, ...) error
- func GenYaml(cmd *cobra.Command, w io.Writer) error
- func GenYamlCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error
- func GenYamlTree(cmd *cobra.Command, dir string) error
- func GenYamlTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenMarkdown ¶
GenMarkdown creates markdown output.
func GenMarkdownCustom ¶
GenMarkdownCustom creates custom markdown output.
func GenMarkdownTree ¶
GenMarkdownTree will generate a markdown page for this command and all descendants in the directory given. The header may be nil. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third`, it is undefined which help output will be in the file `cmd-sub-third.1`.
func GenMarkdownTreeCustom ¶
func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error
GenMarkdownTreeCustom is the the same as GenMarkdownTree, but with custom filePrepender and linkHandler.
func GenReSTCustom ¶
GenReSTCustom creates custom reStructured Text output.
func GenReSTTree ¶
GenReSTTree will generate a ReST page for this command and all descendants in the directory given. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third`, it is undefined which help output will be in the file `cmd-sub-third.1`.
func GenReSTTreeCustom ¶
func GenReSTTreeCustom(cmd *cobra.Command, dir string, filePrepender func(string) string, linkHandler func(string, string) string) error
GenReSTTreeCustom is the the same as GenReSTTree, but with custom filePrepender and linkHandler.
func GenYamlCustom ¶
GenYamlCustom creates custom yaml output.
func GenYamlTree ¶
GenYamlTree creates yaml structured ref files for this command and all descendants in the directory given. This function may not work correctly if your command names have `-` in them. If you have `cmd` with two subcmds, `sub` and `sub-third`, and `sub` has a subcommand called `third` it is undefined which help output will be in the file `cmd-sub-third.1`.
Types ¶
This section is empty.
Source Files