Underlining things with === in docstrings doesn't play well with sphinx, I guess because it expects it to be on a different level then it ends up being on.
Aaron Meurer On Mar 27, 2010, at 12:29 PM, Dan Schult wrote: > > On Mar 27, 2010, at 2:00 PM, Toon Verstraelen wrote: > >> Ondrej Certik wrote: >>> On Sat, Mar 27, 2010 at 7:44 AM, Vinzent Steinberg >>> <vinzent.steinb...@googlemail.com> wrote: >>>> I like mpmath's format: >>>> >>>> **Arguments** >>>> *arg1* >>>> description >>>> *arg2* >>>> description >>> Note that each docstring must (should) contain examples of usage of >>> the function. >>> I like this way: >>> def f(x): >>> """ >>> First line. >>> Some more textlkja sd;lkfj aslfj asl;fdj >>> a;lsdfjal;kskfj lasjdfla;sdkfj >>> Examples: >>> >>> x**2 >>> x**2 >>> """" >>> Notice the indentation, it seems compatible with Python, and also Sage. >> >> OK, thanks. I'll do that. (Apparently the docstrings of the mpmath functions >> are not visible in the html generated by Sphinx, but I'll see how it looks >> like once I try it.) >> >> cheers, >> >> Toon > > To make it visible by sphinx use the rst decorators like: > > Arguments > ========= > > arg1 : argtype > description > arg2 : argtype (optional, default=blah) > description > > This is the style we use in the NetworkX package--we worked from what numpy > had but made small changes. > Dan > > -- > You received this message because you are subscribed to the Google Groups > "sympy" group. > To post to this group, send email to sy...@googlegroups.com. > To unsubscribe from this group, send email to > sympy+unsubscr...@googlegroups.com. > For more options, visit this group at > http://groups.google.com/group/sympy?hl=en. > -- You received this message because you are subscribed to the Google Groups "sympy" group. To post to this group, send email to sy...@googlegroups.com. To unsubscribe from this group, send email to sympy+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sympy?hl=en.
