Back to godoc.org

Package docgen

v0.0.0-...-24fca70
Latest Go to latest

The latest major version is .

Published: Sep 21, 2020 | License: Apache-2.0 | Module: github.com/luci/luci-go

Overview

Package docgen generates documentation from Starlark code.

Index

type Generator

type Generator struct {
	// Starlark produces Starlark module's source code.
	//
	// It is then parsed by the generator to extract documentation from it.
	Starlark func(module string) (src string, err error)
	// contains filtered or unexported fields
}

Generator renders text templates that have access to parsed structured representation of Starlark modules.

The templates use them to inject documentation extracted from Starlark into appropriate places.

func (*Generator) Render

func (g *Generator) Render(templ string) ([]byte, error)

Render renders the given text template in an environment with access to parsed structured Starlark comments.

Package Files

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier