Documentation

Overview

    Package docgen generates documentation from Starlark code.

    Index

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    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.

        Source Files

        Directories

        Path Synopsis
        Package ast defines AST relevant for the documentation generation.
        Package ast defines AST relevant for the documentation generation.
        Package docstring parses docstrings into more structured representation.
        Package docstring parses docstrings into more structured representation.
        Package symbols defines a data model representing Starlark symbols.
        Package symbols defines a data model representing Starlark symbols.