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

Stéfan van der Walt stefan@sun.ac...
Tue Oct 28 04:33:37 CDT 2008


2008/10/28 Gael Varoquaux <gael.varoquaux@normalesup.org>:
> 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.

Certainly -- the idea is to use the :math: tag sparingly.

Cheers
Stéfan


More information about the Scipy-dev mailing list