docgen

Documentation

Overview

Package docgen generates documentation from Starlark code.

Index

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

Types

type Generator

type Generator struct {
	// Normalize normalizes a load() reference relative to the context of the
	// current starlark file.
	Normalize func(parent, ref string) (string, error)
	// 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.

It is a cache of the current loaded modules, which enables following Render() calls to be much faster.

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.

Loaded modules are kept as a cache in Generator, making the rendering of multiple starlark files faster.