emdoc

EmPy documentation generating system. This module requires a modern Python 3.x interpreter.

exception emdoc.DocumentationError(*args, **kwargs)

class emdoc.Extension

The EmPy documentation extension.

class emdoc.Hook(interp)

The EmPy documentation hook.

class emdoc.Identity(pseudo, module)

Dynamically access magic attributes on both the interpreter and underlying module.

class emdoc.Information(pseudo, moduleName, file=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>)

A helper information class to generate documentation.

class Flag(config, options, var=None, env=None, val=None)

Encapsulate a flag: a command line option, a configuration variable, and/or an environment variable.

hashFactory(*, usedforsecurity=True)

Returns a sha1 hash object; optionally initialized with a string

class emdoc.Tee(files)

A file-like object which can split output into multiple files.

emdoc.admonish(text, emoji=None, admonition='important')

Create an admonition.

emdoc.init(pseudo, moduleName, paths=['../..', '.'])

Initialize the information object.