Hi,
I made a doc/ folder on tg2/ to handle the API generation stuff, and
make some modification on module doc strings.
At this moment you could easily generate tg2 APi with epydoc.
There's also a README for API generation instructions :)
Document generation Guide
=========================
You need to install epydoc 3 first before go through this doc.
You could got epydoc source from epydoc svn::
$ svn co https://svn.sourceforge.net/svnroot/epydoc
And follow epydoc's doc to install it.
Check Modules
-------------
To check what docs need to be written, use the command in source
folder::
$ epydoc --check tg
The command will gather all undocumented and no description python
methods.
Generate Docs
-------------
To generate Turbogears2 API, use the command in source folder::
$ epydoc --config doc/doc.ini
to generate API documents into tg2/apidoc folder.
You could custom the doc.ini setting to generate other type of docs.
Write Docs
----------
Note in TurboGears 2 we use reStructuredText format for doc strings
It's a bit different from epydoc's default format.
Check docs about reStructuredText format on epydoc site.
http://epydoc.sourceforge.net/manual-docstring.html
http://epydoc.sourceforge.net/manual-othermarkup.html
http://epydoc.sourceforge.net/manual-fields.html
Debug Docs
-----------
To find where the format error is, use command::
$ epydoc --config doc/doc.ini -v
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"TurboGears Trunk" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/turbogears-trunk?hl=en
-~----------~----~----~----~------~----~------~--~---
