Class: Project
The documentation Project class.
Methods
generate (self)
Create a Generator-object and make it create all requested
pages for each module recursively.
open_in_browser (self)
Open the generated root module's page in the system's default Webbrowser.
parser (self, desc)
Returns the docstring-parser for the descriptor
given in desc.
render_description (self, desc)
Returns the rendered docstring for the descriptor given in
desc as a Genshi-HTML-object.
render_short_desc (self, desc)
Returns the first paragraph from a rendered docstring for the
descriptor given in desc as a Genshi-HTML-object.
render_title (self, desc)
Returns the title (<h1> or <h2>) of a rendered docstring
for the descriptor given in desc as a Genshi-HTML-object.
renderer_id (self, desc)
The Parser's id for the descriptor given
in desc.
Attributes
Value of
NoneValue of
NoneValue of
None