[SciPy-Dev] Using sphinx :func: markup in docstring

Warren Weckesser warren.weckesser@gmail....
Mon Mar 25 08:58:27 CDT 2013


On 3/25/13, Pauli Virtanen <pav@iki.fi> wrote:
> Warren Weckesser <warren.weckesser <at> gmail.com> writes:
>> Is there a policy on using Sphinx hyperlinking references in
>> docstrings?  There are a couple references in scipy.stats that look
>> like they are intended to use Sphinx markup, but they don't actually
>> create links in the HTML output.  Specifically, the ranksums docstring
>> refers to `stats.mannwhitneyu`_, and f_oneway refers to
>> `stats.kruskal`_.  These do not create links in the HTML output.  The
>> only way I've been able to get a link generated is to use, e.g.,
>> :func:`scipy.stats.kruskal`.
>
> `scipy.stats.kruskal` should also generate a link (note: no trailing _).
>


Perfect, thanks.

Warren


> --
> Pauli Virtanen
>
>
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev@scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>


More information about the SciPy-Dev mailing list