On Oct 4, 3:22 am, Fernando Perez <fperez....@gmail.com> wrote:
> ...
> ...
>
> The numpy doc standard may not be perfect, but many of us find that
> it's a very good compromise between plaintext readability and final
> doc generation quality (the :param: style of docstring is very
> annoying for users to read in plaintext).

Thanks for your comprehensive answer, Fernando. I'll definitely give
the numpy doc style and nipy's generator a try, it looks promising.

Concerning Python/reST in general, does anyone know a project which
uses Sphinx' default reST markup (i.e. not numpy doc) in docstrings
extensively?
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to