document

package

v1.13.1 Latest Latest Go to latest Published: Mar 2, 2024 License: GPL-3.0 Imports: 19 Imported by: 1

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

Repository

github.com/norwoodj/helm-docs

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func PrintDocumentation(chartDocumentationInfo helm.ChartDocumentationInfo, chartSearchRoot string, ...)
type DependencyValues
- func GetDependencyValues(root helm.ChartDocumentationInfo, ...) ([]DependencyValues, error)

Constants ¶

View Source

const (
	AlphaNumSortOrder = "alphanum"
	FileSortOrder     = "file"
)

Variables ¶

This section is empty.

Functions ¶

func PrintDocumentation ¶

func PrintDocumentation(chartDocumentationInfo helm.ChartDocumentationInfo, chartSearchRoot string, templateFiles []string, dryRun bool, helmDocsVersion string, badgeStyle string, dependencyValues []DependencyValues)

Types ¶

type DependencyValues ¶ added in v1.9.0

type DependencyValues struct {
	Prefix                  string
	ChartValues             *yaml.Node
	ChartValuesDescriptions map[string]helm.ChartValueDescription
}

func GetDependencyValues ¶ added in v1.9.0

func GetDependencyValues(root helm.ChartDocumentationInfo, allChartInfoByChartPath map[string]helm.ChartDocumentationInfo) ([]DependencyValues, error)

Source Files ¶

View all Source files

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