[QPID-519] Create textual documentation of various modules

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Component/s: Python Client
• Assignee: Unassigned
• Reporter: Jimmy John
• Created: 17/Jun/07 20:48
• Updated: 10/Aug/16 14:46
• Resolved: 08/Jul/08 14:59

Description

We need to create textual descriptions of what the various modules are doing. This will allow people to just read such documentation to gain an understanding of what the modules are doing rather than having to dig through code to figure things out. To see a practical example of this go to http://code.djangoproject.com/browser/django/trunk/docs

Here the documentation is arranged in the form of txt files for each module, so first time users can just browse though it.

Such documentation needs to be placed in the doc folder, so it is available with the python download.