docs

package
v0.16.0 Latest Latest
Warning

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

Go to latest
Published: Dec 3, 2020 License: GPL-3.0 Imports: 6 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateConfigOptionsDocs

func GenerateConfigOptionsDocs(fileName string, flags *pflag.FlagSet)

GenerateConfigOptionsDocs generates an RST-style (ReStructuredText) table for the given flag set, which can serve as documentation for the application. If the target fileName exists, it is overwritten.

func GeneratePartitionedConfigOptionsDocs

func GeneratePartitionedConfigOptionsDocs(fileName string, flags map[string]*pflag.FlagSet)

GeneratePartitionedConfigOptionsDocs is like GenerateConfigOptionsDocs but renders a table with subsections.

Types

This section is empty.

Jump to

Keyboard shortcuts

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