1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
Greetings Python fans,
This collection of modules gives you the ability to extract documentation from
Python source code! I realise that this has been done before using regexp,
but this attempt uses the parser module to parse the code and then
walks the AST to find the appropriate information!!
If you are already fed up with reading then try running the script 'docco.py'
giving it the name of a Python source file (ie. a '.py' NOT a '.pyc').
A FEW HINTS:
docco.py -h gives you some help!
The files included in this distribution are as follows:-
README This file!
ANNOUNCE Why you want to use this code!
LICENSE.DOC Mumbo-jumbo from the legal world 8^(
ast.py Functions to traverse and inspect Python ASTs.
ast_doc.py Functions to extract documentation from Python ASTs.
ASTWalker.py Functions to walk Python ASTs at a higher level of
abstraction than tuples!!!
Doc.py Classes that print/list the documentation.
docco.py The script that puts it all together!!!
Two other files are also included due to the fact that the files token.py
and symbol.py included with our copy of Python were out of date:-
TOKEN.py Generated by h2py from token.h
GRAMINIT.py Generated by h2py from graminit.h
For more information on the source files, run docco.py on them!!!!
Have fun and send all comments/bug reports to /dev/null ...errr... I mean
me ;^)
Martin
_--_|\ Martin Chilvers, Voice: +61-7-3365-4310
/ * Research Scientist, Architectures Unit, Fax: +61-7-3365-4311
\_.--._/ DSTC, Level 7, Gehrmann Laboratories, Email: martin@dstc.edu.au
v The University of Queensland, QLD 4072.
|
