[SciPy-Dev] documentation and sphinx

[Ralf Gommers]

On Thu, May 10, 2012 at 10:42 PM, nicky van foreest <vanforeest at gmail.com>wrote:

> Hi,
>
> I am happily changing some documentation for scipy stats, and in the
> process I am assuming that I can type latex commands just as I do in
> Sphinx. (I also built my home page in sphinx). AFAIK, shpinx makes
> pngs of the formulas, and I had to change some settings in my config
> file for sphinx to enable this  Can I rely on the shpinx version used
> for the numpy/scipy doc that formulas are converted to pngs, or do
> mathematical formulas end up very convoluted?
>

You can use LaTeX with the Sphinx .. math:: directive, but please do so
sparingly - preferably confine it to the Notes section. The reason for that
is that many users read docstrings  in the terminal as plain text, and
LaTeX isn't known for being very readable.

Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20120510/663790dd/attachment.html>