[SciPy-Dev] Strange truncation of autosummary docstring
Mon Jan 16 17:42:54 CST 2012
This may or may not be related to an issue I reported on the sphinx list several months ago. Never did get an answer, but my post includes a possible workaround.
On Jan 14, 2012, at 10:13 PM, Warren Weckesser wrote:
> I just added the rosenbrock functions to the `optimize` module docstring in optimize/__init__.py. When I rebuild the docs, the optimize page (which is html output of the docstring in __init__.py) shows this for rosen_der:
> rosen_der(x) The derivative (i.e.
> It should be
> rosen_der(x) The derivative (i.e. gradient) of the Rosenbrock function.
> The text after 'rosen_der(x)' should be the first line of the docstring.
> Is the truncation because of some cleverness in the numpydoc sphinx extension?
More information about the SciPy-Dev