[SciPy-user] examples in docs
Pauli Virtanen
pav at iki.fi
Tue May 5 12:27:14 EDT 2009
Tue, 05 May 2009 11:46:01 -0400, josef.pktd wrote:
> Rob Falck just pointed out a nice set of examples for fmin_slsqp at
> http://projects.scipy.org/scipy/attachment/ticket/570/slsqp_test.py.
>
> What's the best way to include them in the docs? the tutorial?
The tutorial, I'd say.
> Is there a way to include or link to examples that are too long for a
> docstring?
Add a label like
.. _tutorial-sqlsp:
at the relevant point in the tutorial, and refer it to as
More examples :ref:`in the tutorial <tutorial-sqlsp>`
or :ref:`tutorial-sqlsp` in the docstring, or something along these lines.
--
Pauli Virtanen
More information about the SciPy-User
mailing list