Help us shape the future of Go! Take the 2026 Go Developer Survey

docsgen

package
v0.12.0 Latest Latest
Warning

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

Go to latest
Published: Oct 18, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package docsgen writes the command reference for the documentation site from the Cobra command tree, so the published flags are the flags the binary actually has. cmd/docsgen is its thin main; run it through the Taskfile:

task docs:gen

scripts/check-docs-drift.sh fails the build when the committed pages and the command tree disagree, which is what stops a new flag from shipping undocumented.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Run

func Run(args []string, _, stderr io.Writer) int

Run writes the reference pages into the one directory args names, and returns the status to exit with, saying why on stderr when it fails. stdout is unused: the pages are the output.

Types

This section is empty.

Jump to

Keyboard shortcuts

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