Hi again,
the term docs now include the term call signature, as can be seen e.g. at [1].
It is achieved using 'autodoc-process-docstring' sphinx directive, that allows editing docstrings on-the-fly, see doc/conf.py .
r.
[1] http://docs.sfepy.org/doc-devel/src/sfepy/terms/termsMass.html
-- You received this message because you are subscribed to the Google Groups "sfepy-devel" group. To post to this group, send email to sfepy...@googlegroups.com. To unsubscribe from this group, send email to sfepy-devel...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sfepy-devel?hl=en.
Hi Robert,
On Mon, May 17, 2010 at 8:57 AM, Robert Cimrman <cimr...@ntc.zcu.cz> wrote:
Hi again,
the term docs now include the term call signature, as can be seen e.g. at [1].
Cool, looks great, it should really help new users. :)
It is achieved using 'autodoc-process-docstring' sphinx directive, that allows editing docstrings on-the-fly, see doc/conf.py .
Ah, interesting, will check this out. Could it also be useful for issue 70? I'll look into it when I get some time.
Logan
[1] http://docs.sfepy.org/doc-devel/src/sfepy/terms/termsMass.html
-- You received this message because you are subscribed to the Google Groups "sfepy-devel" group. To post to this group, send email to sfepy...@googlegroups.com. To unsubscribe from this group, send email to sfepy-devel...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sfepy-devel?hl=en.
Hi Logan,
On 05/17/10 17:51, Logan Sorenson wrote:
Hi Robert,
On Mon, May 17, 2010 at 8:57 AM, Robert Cimrman<cimr...@ntc.zcu.cz> wrote:
Hi again,
the term docs now include the term call signature, as can be seen e.g. at [1].
Cool, looks great, it should really help new users. :)
I hope so!
It is achieved using 'autodoc-process-docstring' sphinx directive, that allows editing docstrings on-the-fly, see doc/conf.py .
Ah, interesting, will check this out. Could it also be useful for issue 70? I'll look into it when I get some time.
It could be useful to automatically include the required parameter shapes into the docs, once the terms get annotated with the shapes somehow.
cheers, r.
[1] http://docs.sfepy.org/doc-devel/src/sfepy/terms/termsMass.html
-- You received this message because you are subscribed to the Google Groups "sfepy-devel" group. To post to this group, send email to sfepy...@googlegroups.com. To unsubscribe from this group, send email to sfepy-devel...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sfepy-devel?hl=en.
participants (2)
-
Logan Sorenson -
Robert Cimrman