docgen

Documentation

Overview

Package docgen contains all the executing code of the docgen CLI but in API form

Index

• Variables
• func ReadConfig(path string) (err error)
• func Render() (err error)
• func SetLogger(w io.Writer)
• type AssociationValues

Variables

var (
	// Verbose enables verbose logging ([LOG] and [WARNING] messages)
	Verbose bool

	// Warning enables [WARNING] messages
	Warning bool

	// ExitStatus is what the recommended exit status should be
	ExitStatus int
)

var (
	// ReadOnly defined whether docgen should write rendered documents to disk.
	// This option is useful for testing config
	ReadOnly bool

	// Panic defined whether errors should raise a panic. This is useful for
	// debugging because a stack trace gets raised.
	Panic bool
)

var Config = new(config)

Config is the global configuration for docgen

var Documents documents

Documents is all of the collated documents pre-rendering

Functions

func ReadConfig

func ReadConfig(path string) (err error)

ReadConfig loads a config file from disk

func Render

func Render() (err error)

Render runs docgen

func SetLogger

func SetLogger(w io.Writer)

SetLogger allows output messages to be redirected

Types

type AssociationValues

type AssociationValues struct {
	Extensions []string `yaml:"Extensions"`
	Mimes      []string `yaml:"Mimes"`
}

AssociationValues are associations registered by murex data-types