Issue 3685 in sympy: Rewrite ODE docstrings using LaTeX

[sy...@googlecode.com]

Status: Valid
Owner: ----
Labels: Type-Enhancement Priority-Medium Solvers Documentation EasyToFix

New issue 3685 by asme...@gmail.com: Rewrite ODE docstrings using LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

The ODE docstrings (i.e., the stuff at
http://docs.sympy.org/dev/modules/solvers/ode.html) has a lot of math in
it, but the math is all written in text. We should write it using LaTeX,
and wrap it with backticks (like `x \neq 0`). That way, it will render
nicely in Sphinx. For people who read the text version, I think the pretty
printing in the doctests should be enough.

--
You received this message because this project is configured to send all
issue notifications to this address.
You may adjust your notification preferences at:
https://code.google.com/hosting/settings

[sy...@googlecode.com]

Comment #1 on issue 3685 by Sada...@gmail.com: Rewrite ODE docstrings
using LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

Previously for my personal use I have used matchjax
http://www.mathjax.org , will it work? Please let me know!

[sy...@googlecode.com]

Comment #2 on issue 3685 by asme...@gmail.com: Rewrite ODE docstrings
using LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

Yes sphinx automatically uses mathiax.

[sy...@googlecode.com]

Updates:
Status: Started
Labels: NeedsReview

Comment #3 on issue 3685 by julien.r...@gmail.com: Rewrite ODE docstrings
using LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

https://github.com/sympy/sympy/pull/1976

[sy...@googlecode.com]

Comment #4 on issue 3685 by fawaz.Mo...@gmail.com: Rewrite ODE docstrings
using LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

Hi, is this issue already resolved ?

If not, want to help it.

Please bare with me for any stupid question i may ask. This is my first
trail to contribute in an open source project.

[sy...@googlecode.com]

Comment #5 on issue 3685 by julien.r...@gmail.com: Rewrite ODE docstrings
using LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

As you can see from the github link, work on this has already started, in
fact it looks just about completed. You can help by pulling that branch and
compiling the docs locally; then just comment on anything that could be
improved or give it a stamp of approval if everything looks good.

[sy...@googlecode.com]

Comment #6 on issue 3685 by fawaz.Mo...@gmail.com: Rewrite ODE docstrings
using LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

I generate the document. There are some error messages from sphinx.
Moreover, some mathjax text is not redered correctly. see attached picture.
I also pointed out to two locations where this happens in githut. I will
add more soon.


I'm still learning sphinx tool, and i hope i can correct it soon.

Attachments:
Screen Shot 2013-05-03 at 4.41.15 PM.png 373 KB

[sy...@googlecode.com]

Comment #7 on issue 3685 by a...@hirzel.us: Rewrite ODE docstrings using
LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

I am also working on this. Please email me if you would like to assist.

[sy...@googlecode.com]

Comment #8 on issue 3685 by a...@hirzel.us: Rewrite ODE docstrings using
LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

Update: Fawaz and I will combine efforts.

Also I would like to address the existing pull request linked in #3: I
looked it over and see some room for improvements. I will create a new pull
request in the next few days.

[sy...@googlecode.com]

Comment #9 on issue 3685 by a...@hirzel.us: Rewrite ODE docstrings using
LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

More than half done, comments appreciated:

https://github.com/alhirzel/sympy/commit/6dfeca0d59a9d10bcd422347886376c57aa39532

[sy...@googlecode.com]

Comment #10 on issue 3685 by asme...@gmail.com: Rewrite ODE docstrings
using LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

Can you submit that as a pull request, even if it isn't finished? It will
make it easier to write comments about it (and also the tests will be run
on it automatically by Travis).

[sy...@googlecode.com]

Comment #11 on issue 3685 by a...@hirzel.us: Rewrite ODE docstrings using
LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

Yes; I will submit the partial pull request in the next few days.

[sy...@googlecode.com]

Comment #12 on issue 3685 by a...@hirzel.us: Rewrite ODE docstrings using
LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

https://github.com/sympy/sympy/pull/2142 <--- pull request for this
partially-completed work.

[sy...@googlecode.com]

Updates:
Status: Fixed

Comment #13 on issue 3685 by asme...@gmail.com: Rewrite ODE docstrings
using LaTeX
http://code.google.com/p/sympy/issues/detail?id=3685

(No comment was entered for this change.)