Package gavo :: Package user :: Module docgen

Module docgen

Generation of system docs by introspection and combination with static docs.

Classes
	RSTFragment is a collection of convenience methods for generation of RST.
	ParentPlaceholder is a sentinel left in the proto documentation, to be replaced by docs on the element parents found while processing.
	DocumentStructure a dict keeping track of what elements have been processed and which children they had.
	StructDocMaker A class encapsulating generation of documentation from structs.
	MacroDoc documentation for a macro, including the objects that know about it.
	KnownMacros An accumulator for all macros known to the various DaCHS objects.

Functions

getDocName(klass)

source code

formatKnownMacros(docStructure)

source code

getStructDocs(docStructure)

source code

getStructDocsFromRegistry(registry, docStructure)

source code

getGrammarDocs(docStructure)

source code

getCoreDocs(docStructure)

source code

getActiveTagDocs(docStructure)

source code

getRendererDocs(docStructure)

source code

getTriggerDocs(docStructure)

source code

getMixinDocs(docStructure, mixinIds)

source code

getRmkFuncs(docStructure)

source code

getRegtestAssertions(docStructure)

source code

makeSystemTablesList(docStructure)

source code

getStreamsDoc(idList)

source code

getMetaKeyDocs()

source code

getAPIDocs(docStructure)

source code

makeReferenceDocs()
returns a restructured text containing the reference documentation built from the template in refdoc.rstx.

source code

refdoc(args)

source code

latex(args)

source code

html(args)

source code

main()

source code

Variables
	NO_API_SYMBOLS = `frozenset(['AdhocQuerier', 'ParseOptions', '_...`
	__package__ = `'gavo.user'`

Function Details

makeReferenceDocs()

source code

returns a restructured text containing the reference documentation built from the template in refdoc.rstx.

**WARNING**: refdoc.rstx can execute arbitrary code right now. We probably want to change this to having macros here.

refdoc(args)

source code

Decorators:

@exposedFunction([], help= "Writes ReStructuredText for the reference" " documentation to stdout")

latex(args)

source code

Decorators:

@exposedFunction([Arg(help= "Input file name", dest= "src")], help= "Turns ReStructured text (with DaCHS extensions) to LaTeX source")

html(args)

source code

Decorators:

@exposedFunction([Arg(help= "Input file name", dest= "src")], help= "Turns ReStructured text (with DaCHS extensions) to HTML")

Variables Details

NO_API_SYMBOLS

Value:

frozenset(['AdhocQuerier',
           'ParseOptions',
           '__builtins__',
           '__doc__',
           '__file__',
           '__name__',
           '__package__',
           'addCartesian',
...