Comment #13 on issue 1215 by asmeurer: fix html documentation
http://code.google.com/p/sympy/issues/detail?id=1215

I did not intend for the == Titles == to be rendered with Sphinx.  I would  
like to do

Title
=====

but Sphinx will not allow it.  I just wrote them so they would look nice in  
the monospace docstring, either from help() or from someone
looking at the source.  If something like **Title** would look nice in  
both, then that would be OK too (it seems impossible to underline it
with any characters that would make it look any good).

Thanks for catching the Bernoulli one.  It seems that that worked before  
commit ae528b0c, which changed the last >>> to >> (the
doctest needs to be skipped and # SKIP does not work in Python2.4).  We  
need to be more careful before committing docstring changes
that they still look OK in the Sphinx.  I am actually not so sure now why I  
skipped that test.  It seems to run fine for me, and it isn't slow.
So it just needs to be made into a regular test

And also a note on the ODE docs, sphinx gives several warnings and errors.   
This is because it wants you to indent the code a ridiculous
amount, and the html looks exactly the same if you indent it or if you  
leave it alone (the only difference is that Sphinx does not bug you if
you indent it).  On the other hand, the docstrings themselves are already  
indented one or two times and it is hard enough to make it fit in
a nice 80-85 character range (c.f. the general case of the Bernoulli ODE at  
the top of the ode_Bernoulli docstring).  To put it simply, if
something has the choice of looking nice in the help() docstring and  
looking nice in the Sphinx, I choose the help() version.  Just thought I
would throw that out there, because I figured it would probably come up at  
some point anyway.

--
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 sympy-iss...@googlegroups.com.
To unsubscribe from this group, send email to 
sympy-issues+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sympy-issues?hl=en.


Reply via email to