[Twisted-Python] Documentation Lacks

Andrew Bennetts andrew-twisted at puzzling.org
Tue Dec 31 23:32:47 EST 2002


On Wed, Jan 01, 2003 at 02:55:38PM +1100, screwtape at froup.com wrote:
> On Sat, Dec 28, 2002 at 10:54:07AM -0000, Moshe Zadka wrote:
> > Hi.
> > The following things are undocumented -- any volunteers would be welcome:
> >  - Twisted chat HOWTO (im, words server, writing bots)
> 
> In case I accidentally stumble upon some time in the near future, what
> are the requirements for documentation writing? Are plain text files
> good enough, or HTML?

Look at the existing docs in doc/howto for examples.  They are in "Lore"
format, which is a subset of XHTML.  See doc/howto/doc-standard.html for
details (or http://twistedmatrix.com/documents/howto/doc-standard).

-Andrew.





More information about the Twisted-Python mailing list