docsgen

package
v0.11.621 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Options

type Options struct {
	InputPath               string
	OutputPath              string
	Title                   string
	Variant                 string
	PipelineDefinitionFiles []string
	GeneratedAt             time.Time
	// ExcludeCode strips asset source content from the generated docs. By
	// default the full asset source is embedded so it can be viewed inline.
	ExcludeCode bool
}

type PipelineBuilder

type PipelineBuilder interface {
	CreatePipelinesFromPath(ctx context.Context, path string, opts ...pipeline.CreatePipelineOption) ([]*pipeline.Pipeline, error)
}

type Result

type Result struct {
	OutputPath    string
	SearchRoot    string
	PipelineCount int
	AssetCount    int
}

func Generate

func Generate(ctx context.Context, builder PipelineBuilder, opts Options) (*Result, error)

Jump to

Keyboard shortcuts

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