Documentation generation about omcache HOT 6 CLOSED

readthedocs.com can help there. No need to do anything besides hooking it to your github repository.

from omcache.

I'm really interested in this project but I can't use it as it is.
It really needs documentation to move forward.

from omcache.

The C API is documented in omcache_cdef.h but the Python API is still lacking documentation. It's pretty straightforward, though, and the API implemented by omcache_pylibmc.py matches what pylibmc implements and documents so you could use it as a starting point. I'll try to write some docs for the Python API and add some example uses of the APIs sometime soon. You can also look at the unit tests and how they utilize the c and python apis.

from omcache.

The problem is that the omcache_pylibmc is an experimental and just for demonstration.
I can't really use it.

from omcache.

Documentation is now autogenerated for the C API and published in http://omcache.readthedocs.org/ - will create a new ticket about documenting the Python api.

from omcache.

Thank you!

from omcache.