| 1 |
jan |
2345 |
$Id$ |
| 2 |
|
|
|
| 3 |
|
|
Currently, there is no explicit document on the implementation |
| 4 |
jan |
2348 |
details but a UML description of the Model Module: |
| 5 |
|
|
ThubanModul.xmi |
| 6 |
|
|
You can edit this file with Umbrello. |
| 7 |
|
|
|
| 8 |
|
|
Furthermore, you can generate class and method description |
| 9 |
jan |
2345 |
automatically from the source code: |
| 10 |
|
|
|
| 11 |
|
|
pydoc coming with Python can be quite useful as a class browser. |
| 12 |
|
|
If you want to use it on Thuban, you need to give it the right |
| 13 |
|
|
paths so you can browse all of it. |
| 14 |
|
|
|
| 15 |
|
|
e.g. , the following starts pydoc as webbrowser on localhost:1234/ |
| 16 |
|
|
cd thuban |
| 17 |
|
|
PYTHONPATH=./Lib:./test/ pydoc -p 1234 |
| 18 |
|
|
|
| 19 |
|
|
A brief look into other documentation tools |
| 20 |
|
|
resulted in that the the best overview about them was coming with |
| 21 |
|
|
epydoc at: |
| 22 |
|
|
http://epydoc.sourceforge.net/relatedprojects.html |
| 23 |
|
|
|
| 24 |
|
|
epydoc seems to be very solid, because the author did a lot |
| 25 |
|
|
of reseach and decided for a very simple markup language. |
| 26 |
bernhard |
2728 |
It might be surpassed one day by docutils which use the more |
| 27 |
jan |
2345 |
complicated reStructured text as markup. |
| 28 |
|
|
|
| 29 |
|
|
As nice side contender is happydoc, because it does not import |
| 30 |
|
|
the python modules. |
Parent Directory
| 
Revision Log