docs

package

v0.3.0 Latest Latest Go to latest Published: Aug 11, 2026 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/microsoft/azure-linux-dev-tools

Links

Open Source Insights

Documentation ¶

Index ¶

func CheckOutputDir(fs opctx.FS, options *GenerateMarkdownOptions) error
func GenerateMarkdownDocs(fs opctx.FS, rootCmd *cobra.Command, options *GenerateMarkdownOptions) error
func OnAppInit(app *azldev.App)
type AgentInstallOptions
type GenerateMarkdownOptions
type InstalledAgentFile
- func InstallAgentFiles(env *azldev.Env, rootCmd *cobra.Command, options *AgentInstallOptions) ([]InstalledAgentFile, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CheckOutputDir ¶

func CheckOutputDir(fs opctx.FS, options *GenerateMarkdownOptions) error

CheckOutputDir verifies the output directory state before generation. If the directory exists and is non-empty, it either removes it (when Force is set) or returns an actionable error suggesting --force / -f.

func GenerateMarkdownDocs ¶

func GenerateMarkdownDocs(fs opctx.FS, rootCmd *cobra.Command, options *GenerateMarkdownOptions) error

GenerateMarkdownDocs generates markdown documentation for the given command tree.

func OnAppInit ¶

func OnAppInit(app *azldev.App)

Called once when the app is initialized; registers any commands or callbacks with the app.

Types ¶

type AgentInstallOptions ¶ added in v0.3.0

type AgentInstallOptions struct {
	OutputDir string
	Full      bool
	Layout    string
}

AgentInstallOptions holds the options for the 'docs agent install' command.

type GenerateMarkdownOptions ¶

type GenerateMarkdownOptions struct {
	OutputDir     string
	IncludeHidden bool
	Force         bool
}

type InstalledAgentFile ¶ added in v0.3.0

type InstalledAgentFile struct {
	Path    string `json:"path"`
	Written bool   `json:"written"`
}

InstalledAgentFile describes a single agent file written (or, in dry-run mode, that would be written) by the 'docs agent install' command.

func InstallAgentFiles ¶ added in v0.3.0

func InstallAgentFiles(
	env *azldev.Env, rootCmd *cobra.Command, options *AgentInstallOptions,
) ([]InstalledAgentFile, error)

InstallAgentFiles renders and writes (or, in dry-run mode, reports) the azldev agent files into the output directory named by options.

Source Files ¶

View all Source files

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