[SciPy-dev] Of use and abuse of sphinx's math directive

Gael Varoquaux gael.varoquaux@normalesup....
Tue Oct 28 03:18:08 CDT 2008


Howdy,

Sphinx is great, will all love Sphinx. But I do wonder if sometimes we do
not use the math directive a bit too much, eg the "n" and "n-1" on:
http://scipy.org/scipy/scipy/browser/trunk/scipy/cluster/hierarchy.py#L1090
(this is just an example that I picked randomly).

When the formula written is simple-enought that its readibility is not
too much affected by having it in text in the Sphinxified document, I
think it is a pitty to render the plain text docstrings hard-to-read.

What do people think?

Gaël


More information about the Scipy-dev mailing list