Package Ganga :: Package Runtime :: Module gangadoc

Module gangadoc

Improved support for interactive help based on pydoc. Remove hardcoded limits on the help text. This module makes changes to the content of the pydoc module.

Classes

[hide private]

TextDoc2

Helper2

Functions

[hide private]

adddoc(name, object, doc_section, docstring)
Add automatic documentation to gangadoc system.

source code

makedocindex()
Return a string with GPI Index.

source code

mygetmodule(object)
Return the module an object was defined in, or None if not found.

source code

doc2(thing, title='Python Library Documentation: %s', forceload=0)
Display text documentation, given an object or a path to an object. source code

Variables

[hide private]

_GPIhelp = 'Ganga Public Interface (GPI) Index\n\n%(Classes)s\...

_GPIhelp_sections = {'Classes': [], 'Exceptions': [], 'Functio...

modulesbyfile = {}

__package__ = 'Ganga.Runtime'

Function Details

[hide private]

adddoc(name, object, doc_section, docstring)

source code

Add automatic documentation to gangadoc system. "doc_section" specifies how the object should be documented. If docstring is specified then use it to document the object. Otherwise use __doc__ (via pydoc utilities).

Variables Details

[hide private]

_GPIhelp

Value:

'''Ganga Public Interface (GPI) Index

%(Classes)s

%(Exceptions)s

%(Functions)s

...

_GPIhelp_sections

Value:

{'Classes': [],
 'Exceptions': [],
 'Functions': [('jobSlice', <function jobSlice at 0x1ad1a28>, None)],
 'Objects': []}