docgen

package
v0.8.0-a.4 Latest Latest
Warning

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

Go to latest
Published: Jun 15, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package docgen renders unobin reference documentation as Markdown for the docs site.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func APIReference

func APIReference(pkg *doc.Package, fset *token.FileSet) string

APIReference renders a parsed package's exported API as a Markdown page: the package documentation, then its constants, variables, functions, and types, with each type followed by its own constructors and methods. go/doc sorts every group by name, so the output is deterministic.

func CLIReference

func CLIReference(root *cobra.Command) string

CLIReference renders the command tree rooted at root as a single Markdown page: an intro from the root's own description, then one section per visible command, nested by depth. Commands and flags are emitted in lexical order, so the output is identical on every run and can be regenerated without churn.

Types

This section is empty.

Jump to

Keyboard shortcuts

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