1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
The Python Documentation Tool
-----------------------------
This collection of Python modules extracts documentation from Python source
code! The documentation can be output in either text or HTML form.
Python documentation can currently be obtained from modules, class, method,
and function definitions. There are emerging conventions about the content
of the documentation strings and an introduction to the topic can be found at
the back of the Python Tutorial.
The benefit of using a tool such as this is that programmers can document
their code in the source files and the documentation can then be
extracted and presented automagically.
The modules have been designed with extensibility in mind. It is easy (ney
pathetically trivial) to add new classes to handle the documentation in any
way that you so desire.
Enjoy!
|
