generator

Documentation

Overview

Documentation generator for Gollum

Reads in Go source files from a given file or directory. Generates end-user documentation in RST format for Gollum plugins found therein.

The data is processed as follows:

*.go sources
  -> ast.Node/ast.Package/etc objects
    -> GollumPlugin objects
       -> PluginDocument objects [recursively process embedded types' sources]
          -> RST strings