pdk.Tools.pdkdoc ($Date: 2002/12/17 13:47:25 $)
index
pdk/Tools/pdkdoc.py

pdk source code documentation tool.

This is a hack cobbling together structured text markup with the standard pydoc, spiced up with a few extra features. Needs the docutils package (http://docutils.sourceforge.net).

FOG 08.2002

 
Modules
            
inspect
os
pdk.Tools._pydoc
re
 
Classes
            
pdk.Tools._pydoc.HTMLDoc(pdk.Tools._pydoc.Doc)
pdkHTMLDoc
 
class pdkHTMLDoc(pdk.Tools._pydoc.HTMLDoc)
       
  
Method resolution order:
pdkHTMLDoc
pdk.Tools._pydoc.HTMLDoc
pdk.Tools._pydoc.Doc

Methods defined here:
markup(self, text, escape=None, funcs={}, classes={}, methods={}, data={})
page(self, title, contents)
 
Functions
            
StringIO(...)
StringIO(s) -- Return a StringIO-like stream for reading or writing
convert_structured_to_html(text)
parses the structured text text and converts it to html.
geturl(object)
 
Data
             HIDE_INHERITED = 4
HIDE_PRIVATE = 1
HIDE_PROTECTED = 2
PDKPATH = '/netshare/home/finell/pdk/pdk'
STYLESHEETFILENAME = 'pdkdoc.css'
STYLESHEETFULLPATH = '/usr/local/lib/python2.2/site-packages/pdk/Tools/pdkdoc.css'
__author__ = '$Author: finell $'
__date__ = '$Date: 2002/12/17 13:47:25 $'
__revision__ = '$Revision: 1.7 $'
__source__ = '$Source: /home/cvs/pdk/pdk/Tools/pdkdoc.py,v $'
bodyPattern = <_sre.SRE_Pattern object>
parser = instance of Parser
styleSheetPattern = <_sre.SRE_Pattern object>
writer = instance of Writer
 
Author
            
$Author: finell $