Hello, On Fri, Nov 18, 2011 at 1:48 AM, Nathann Cohen <[email protected]> wrote: > Would anyone know if it is possible in a module's docstring to > "interrupt" the documentation ? > > I would like to write something like that : > > "This module deals with [....]. Here is the first block of functions" > > def function(): > r"""the function's documentation""" > > "And here is the second one" > > def function2(): > r"""the function's documentation""" > > Only the second docstring is ignored (does not appear in the HTML > documentation) :-)
No, it's not possible since the second string doesn't get saved anywhere. Sphinx doesn't parse the module, it just reads the Python created docstrings, and only the first is saved under module.__doc__. If you want more control over the resulting documentation, just create a .rst file in the documentation. --Mike -- To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/sage-support URL: http://www.sagemath.org
