Updates:
Cc: [email protected] [email protected]
Comment #9 on issue 2537 by asmeurer: Use MathJax in the docs
http://code.google.com/p/sympy/issues/detail?id=2537
The math_dollar extension is broken. According to the docstring in the
file, it properly doesn't try to convert expressions in indented lines, or
expressions like ``$HOME``, but neither works. This is why for example we
have stuff like ":math: ` tar xzf sympy-0.5.12.tar.gz" at
http://docs.sympy.org/0.7.0/tutorial.html (it should be "$ tar xzf
sympy-0.5.12.tar.gz". It also doesn't even try to stop capturing at a
newline, which it probably should.
I've had little luck fixing it, which is probably just a lack of regex fu
on my part. I think we should just remove math_dollar support and require
inline math to be surrounded by `.
- Skipping indented lines is not enough, because such lines are not
necessarily code examples (they need to be preceded by :: I think). Thus,
skipping dollar signs only in code blocks is a much less trivial problem
then skipping indented lines.
- It's not as easy as requiring all explicit dollar signs to be escaped,
because that would break dollar signs in doctests, e.g., doctests for the
latex() function (you can see at
http://docs.sympy.org/0.7.0/tutorial.html#printing that it claims that
latex(x**2, mode='inline') returns `x^{2}$, but it's actually $x^{2}$ and
the math_dollar extension has screwed up the first $). You can't escape $
in the doctest because it would break the testing of the doctest, which is
based on what is in the txt file, not the generated html.
- Like I said above, I've had no luck fixing this, and have lost ambition
to do so.
If someone wants to try fixing the math_dollar extension to fix the above,
that would be great. Otherwise, I am going to just drop support for it and
replace all $math$ with `math`, which is a perfectly fine way to write math
imho.
Right now, it's only used in Mateusz's polys documentation and in Tom's
gsoc branch. How do you two feel about this change?
--
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.
