future of mpl documentation

I saw this package for math markup mentioned in the docutils FAQ:

   http://docutils.sourceforge.net/sandbox/jensj/latex_math/

It should allow you to include latex markup in the docstrings.

Has anyone tried it?

  - Paul

···

On Thu, May 22, 2008 at 02:44:43PM -0400, Darren Dale wrote:

Here is the docstring for the texmanager module:

Yes, Jens Mortenson pointed out it out on sphinx-dev a while back, it is
already included in our trunk :slight_smile: Georg Brandl kindly added a new option in
svn so we can produce files with .xml file extensions instead of .html, which
are required to render mathml.

I dont have an example yet in the matplotlib docs, but I played with it in my
XPaXS documents, you can see it here:

http://dale.chess.cornell.edu/~darren/temp/XPaXS/reflectivity.xml#matrix-method

There is a "show source" link on the left that shows the original ReST wource
for the current page, here is the math markup:

:math:`sin(x_n^2)`

.. math::

   \int_{-\infty}^{\infty}\frac{e^{i\phi}}{1+x^2\frac{e^{i\phi}}{1+x^2}}

The latex file also renders the equations nicely.

Darren

···

On Thursday 22 May 2008 5:03:31 pm Paul Kienzle wrote:

On Thu, May 22, 2008 at 02:44:43PM -0400, Darren Dale wrote:
> Here is the docstring for the texmanager module:

I saw this package for math markup mentioned in the docutils FAQ:

   http://docutils.sourceforge.net/sandbox/jensj/latex_math/

It should allow you to include latex markup in the docstrings.

Has anyone tried it?