epydoc.html.HTML

Package	Module	Class	Trees	Index	Help

epydoc

[show private | hide private]

epydoc.html
Class epydoc.html.HTML_Doc

Documentation to HTML converter.

For each module/package, create a file containing:

For each class, create a file containing:

Also, generate an index file, a help file, and a tree file.

Method Summary
	`__init__(self, docmap, **kwargs)` Construct a new HTML outputter, using the given `DocMap` object.
`None`	`write(self, directory, progress_callback)` Write the documentation to the given directory.

Instance Variable Summary
`DocMap`	`docmap` - The documentation object, encoding the objects that should be documented.

Method Details

__init__(self, docmap, **kwargs)

Construct a new HTML outputter, using the given DocMap object.

Parameters:

docmap - The documentation to output.
(type=DocMap)

kwargs - Keyword arguments:

prj_name: A name for the documentation (for the navbar). This name can contain arbitrary HTML code (e.g., images or tables). (type=string)
prj_url: A URL for the documentation (for the navbar). (type=string)
css: The CSS stylesheet file. If css is a file, then its conents will be used. Otherwise, if css is the name of a CSS stylesheet in epydoc.css, then that stylesheet will be used. Otherwise, an error is reported.

write(self, directory=None, progress_callback=None)

Write the documentation to the given directory.

Parameters:: directory - The directory to which output should be written. If no directory is specified, output will be written to the current directory. If the directory does not exist, it will be created.
(type=string); progress_callback - A callback function that is called before each file is written, with two arguments: the name of the created file (string); and the object documented by the file, if any (ObjDoc).
(type=function)

Raises:: OSError - If directory cannot be created, or if any file cannot be created or written to.

Instance Variable Details

The documentation object, encoding the objects that should be documented.

Package	Module	Class	Trees	Index	Help

epydoc

Generated by Epydoc on Sun Oct 6 03:32:13 2002