Comment #8 on issue 1215 by asmeurer: only some modules are listed on the  
docs
http://code.google.com/p/sympy/issues/detail?id=1215

This could be more difficult than you might think.  Many docstrings that  
are not included in the docs are incompatible with
sphinx, so they will have to be modified (which in my experience can take  
some trickery and time to figure out).  For example,
sphinx will not allow titles in docstrings that look like

This
====

Because that is the format of sphinx titles and they conflict.  So they  
will have to be changed to look like

== This ==

as in simplify.py.  Aside from that, anything that you want to be indented  
is a mess.  It usually forces you to indent one or two
more times than you wanted in order to compile, or it will bug you with  
warnings when there is nothing wrong even with the
compiled file (c.f. ode docstrings).

At any rate, I agree that it needs to be done.  This documentation is what  
is put online, and it is where new users look first
before looking around docstrings.

--
You received this message because you are listed in the owner
or CC fields of this issue, or because you starred this issue.
You may adjust your issue notification preferences at:
http://code.google.com/hosting/settings

--

You received this message because you are subscribed to the Google Groups 
"sympy-issues" group.
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/sympy-issues?hl=en.


Reply via email to