Open GoogleCodeExporter opened 9 years ago
Aspen doc (.tex files) are in aspen subversion.
Original comment by bserg...@gmail.com
on 16 Jan 2007 at 10:13
Here is a cool tool for generating developper (API) documentation, like doxygen
or
javadoc. http://epydoc.sourceforge.net/
The Mandriva package is called epydoc. Here is how to use it:
[bsergean@marge1 trunk]$ epydoc -o doc pytof
Importing 19 modules.
[...................]
Building API documentation for 19 modules.
[..
===========================================================================
/home/bsergean/src/pytof/trunk/pytof/PListReader.py
In pytof.PListReader docstring (line 1):
---------------------------------------------------------------------------
L10: Error: Improper paragraph indentation.
L15: Error: Improper paragraph indentation.
L18: Error: Improper paragraph indentation.
L21: Error: Improper paragraph indentation.
L22: Error: Improper paragraph indentation.
L27: Error: Improper paragraph indentation.
L28: Error: Improper paragraph indentation.
L33: Error: Improper paragraph indentation.
L36: Error: Improper paragraph indentation.
L37: Error: Improper paragraph indentation.
......
===========================================================================
/usr/lib/python2.4/ftplib.py
In ftplib.FTP docstring (line 77):
---------------------------------------------------------------------------
L80: Error: Improper paragraph indentation.
.........
===========================================================================
/home/bsergean/src/pytof/trunk/pytof/utils.py
In pytof.utils.posixpath docstring (line 53):
---------------------------------------------------------------------------
L54: Error: Improper paragraph indentation.
L55: Error: Improper paragraph indentation.
L58: Error: Improper paragraph indentation.
L59: Error: Improper paragraph indentation.
..]
Writing HTML docs (79 files) to 'doc'.
[ 1%] ............................................................
[ 77%] ...................
I have posted a sample of the generated doc on the download page:
http://pytof.googlecode.com/files/epydoc-for-pytof.tgz
Original comment by bserg...@gmail.com
on 15 Mar 2007 at 5:32
Now the next step are:
- Write module documentation.
- Add a devdoc target to the Makefile, put those file
- Put those file under subversion
- Set their type to Content/html or something like that
- Put a link on the pytof main page to the API documentation (through the subversion
stuff).
Maybe it's a bad habit to serve file (even doc) though subversion, we should
ask this
question on the google code mailing list before doing steps 4 and 5.
Original comment by bserg...@gmail.com
on 15 Mar 2007 at 5:42
Original issue reported on code.google.com by
bserg...@gmail.com
on 16 Jan 2007 at 9:53