On Tue, Nov 16, 2010 at 11:08 AM, Jamu Kakar <[email protected]> wrote:
> +1, this all sounds good to me.  Let's do it! :)

Here is a very basic use of the autodoc feature:

lp:~jamesh/storm/documentation

I've added to .rst files for store and resultset that include some
autodoc directives.  I've also added a "make coverage" target to the
documentation makefile.  Note that it is only checking coverage of
modules that have a ".. module::" directive in the documentation (so
currently only storm.store).

Looking at the documentation for the autodoc extension, it seems like
it might be possible to translate the epydoc markup by hooking one of
the events, but it might be simpler to just convert the docstrings to
reStructuredText directly.

James.

-- 
storm mailing list
[email protected]
Modify settings or unsubscribe at: 
https://lists.ubuntu.com/mailman/listinfo/storm

Reply via email to