Write module documentation about pyftpdlib HOT 6 CLOSED

I think first and foremost we should fully document the module using detailed
docstrings. There are a number of tools for creating documentation from docstrings
that let you use formatting similar to javadoc, which might be worth looking into
also. I found epydoc, which also has a decent summary of several tools 
available for
Python documentation: http://epydoc.sourceforge.net/relatedprojects.html With 
regards to the writing wiki or LaTeX documentation, the wiki will be convenient
and easy for us to use. However, if we want to provide documentation with the
pytftpdlib package (e.g. HTML doc pages), then the wiki will not be able to be used
for that purpose. I recommend that we use the wiki for writing up interesting pieces
of information that don't necessarily make sense to include in 'formal' 
documentation
for a module. For instance, we could use it to include interesting uses of pyftpdlib,
samples of code, FAQs, etc. 

For documentation included with pyftpdlib, we can use a tool like epydoc or one of
the projects listed above to generate HTML/PDF API and usage documentation to put in
the doc/ folder. IMHO, learning LaTeX just to write docs for a module seems overkill
and it would be easier for us to use a convenience tool to generate the docs from the
module itself. This also has the added benefit that users can use pydoc to retrieve
basic doc information,

Docstrings have been updated by Jay Loden into SVN revision #70 for module to include
consolidated version of the module overview as well as cleaning up some of the
wording and comments enhancements.

Actually some provisional FAQs, API Reference and Tutorial wikis are available on a
temporary GoogleCode project I created for writing drafts and doing tests: 
https://code.google.com/p/billiejoex/w/list Note that all wikis refers to the 
upcoming 0.2.0 version which breaks some backward
API compatibilities with the current one.

Using Wiki seems to be a good choice excepting for the API Reference which should be
written by using one of the tools you mentioned.

I find reasonable to provide also wiki papers with the package release. A kind of
python script converting Wiki markup language into an HTML page could be optionally
written.

Added FAQ and Tutorial wikis (svn revision #100 ).
I'm waiting for Jay Loden to take a last look at them, then I'll make a dump for
converting them into static HTML files to include into distribution.

Wikis dumped into HTML static files added into 0.2.0 release which is now 
finally out.