exportToGPI(name,
object,
doc_section,
docstring=None)
| source code
|
Make object available publicly as "name" in Ganga.GPI module. 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 (only use for "Objects" section). Otherwise use __doc__ (via pydoc utilities).
FIXME: if you try to export the object instance, you should import it with fully qualified path, e.g.
import X.Y.Z
X.Y.Z.object = object
exportToGPI("obj",X.Y.Z.object,"Objects")
It has been observed that doing exportToGPI("obj",object,"Objects") may not work. To be understood.
|