disipyldoc (version 1.3)
index
/data/via_samba/pmagwene/pmag/pyth/disipyl/disipyldoc.py

A module for generating disipyl documentation.
 
-----------------------------------------------------------------------------
(c) Copyright by Paul M. Magwene, 2002  (mailto:paul.magwene@yale.edu)
 
    Permission to use, copy, modify, and distribute this software and its
    documentation for any purpose and without fee or royalty is hereby granted,
    provided that the above copyright notice appear in all copies and that
    both that copyright notice and this permission notice appear in
    supporting documentation or portions thereof, including modifications,
    that you make.
 
    THE AUTHOR PAUL M. MAGWENE DISCLAIMS ALL WARRANTIES WITH REGARD TO
    THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
    FITNESS, IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL,
    INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
    FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
    NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
    WITH THE USE OR PERFORMANCE OF THIS SOFTWARE !
-----------------------------------------------------------------------------

 
Modules
            
disipyl.complexplots
disipyl.contours
disipyl.demos
disipyl
disipyldoc
disipyl.mlabplots
disipyl.plots
disipyl.pxdislin
disipyl.pxdislin3D
disipyl.pydislin
pydoc
disipyl.quickplots
disipyl.tkdisipyl
disipyl.utilities
 
Functions
            
doDynamicDoc(ldict, ldir, classtype)
Dynamically updates the documentation for classes with an 'option' dictionary.
generateDisipylDocs()
Generate HTML documentation for all modules in global variable 'modlist'
generateDislinDocs()
generateHTML(module, packagename='')
Generates HTML docs for all classes in given module.
generateSelfDoc()
optionString(object)
Returns string containing all the options of a class with an 'option' dict.
 
Data
             __author__ = 'Paul M. Magwene '
__credits__ = ''
__file__ = './disipyldoc.py'
__name__ = 'disipyldoc'
__version__ = '$Revision: 1.1.1.1 $'
modlist = [<module 'disipyl.pydislin' from '/home/pmagwene/data/pmag/pyth/disipyl/pydislin.pyc'>, <module 'disipyl.pxdislin' from '/home/pmagwene/data/pmag/pyth/disipyl/pxdislin.pyc'>, <module 'disipyl.pxdislin3D' from '/home/pmagwene/data/pmag/pyth/disipyl/pxdislin3D.pyc'>, <module 'disipyl.plots' from '/home/pmagwene/data/pmag/pyth/disipyl/plots.pyc'>, <module 'disipyl.complexplots' from '/home/pmagwene/data/pmag/pyth/disipyl/complexplots.pyc'>, <module 'disipyl.contours' from '/home/pmagwene/data/pmag/pyth/disipyl/contours.pyc'>, <module 'disipyl.demos' from '/home/pmagwene/data/pmag/pyth/disipyl/demos.pyc'>, <module 'disipyl.tkdisipyl' from '/home/pmagwene/data/pmag/pyth/disipyl/tkdisipyl.pyc'>, <module 'disipyl.mlabplots' from '/home/pmagwene/data/pmag/pyth/disipyl/mlabplots.pyc'>, <module 'disipyl.quickplots' from '/home/pmagwene/data/pmag/pyth/disipyl/quickplots.pyc'>]
 
Author
             Paul M. Magwene <paul.magwene@yale.edu>
 
Credits