List escribió:
> Does anybody maintain a reasonably accurate list of methods and 
> attributes, in a reference type format for SQLObject?  The various 
> tutorials and release notes are nice, but a consolidated list would save 
> a lot of searching around.
>
> Thanks in advance.
>   

I use epydoc[1] to generate the API documentation and consult it 
locally. This is my command:

epydoc -o /home/jonhattan/doc/sqlobject-api --name "SQLObject API Doc" 
-v /usr/lib/python2.5/site-packages/SQLObject-0.9.0-py2.5.egg/sqlobject/

note -o is the outputdir and -v your sqlobject location

I've put the generated api doc online at [2] in order to show you the 
results.

epydoc generates the documentation based on the python docstrings, that 
unfortunatelly are not very present in sqlobject code. Anyway it's a 
very useful to have the list of methods and attrs.

I'm very new to sqlobject. I think I can do my contribution by writing 
docstrings.

What about having the epydoc-generated-api-doc in a non-personal web 
location and linked from the sqlobject mainpage? (I can provide webspace 
at http://software.opentech.es if it's needed)

[1] http://epydoc.sourceforge.net/
[2] http://opentech.es/~jonhattan/sqlobject-api



jonhattan


> Tom
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by DB2 Express
> Download DB2 Express C - the FREE version of DB2 express and take
> control of your XML. No limits. Just data. Click to get it now.
> http://sourceforge.net/powerbar/db2/
> _______________________________________________
> sqlobject-discuss mailing list
> sqlobject-discuss@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/sqlobject-discuss
>
>   


-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
sqlobject-discuss mailing list
sqlobject-discuss@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/sqlobject-discuss

Reply via email to