[Twisted-Python] f33r the API docs
Itamar Shtull-Trauring
lists at itamarst.org
Sun Oct 7 12:30:00 EDT 2001
Check this out:
<http://itamarst.org/twisted-docs/twisted.html>
The output will be that much more cleaner and informative if you add a
__all__ list to your package. __all__ is the list of objects you want to be
exported when somone does "from yourmodule import *" and is used by my
documentation program to decide what to document. It is a simple list of
strings. For example:
===========================================
import sys
_list = []
def addToList(object):
"""add an object to the list"""
_list.append(object)
CONSTANT = 3
__all__ = ["addToList", "CONSTANT"]
===========================================
More information about the Twisted-Python
mailing list