链接到另请参阅Sphinx文档字符串中的函数

时间:2016-12-05 17:34:50

标签: python python-sphinx

当我为我的python包编写文档字符串时,我无法使函数出现在See Also部分可链接,特别是对于属于其他模块的函数,可能有人帮我解决这个问题问题,谢谢!

BTW,我遵循numpy文档字符串规则,并且所有API文档都是从sphinx-autogen生成的,下面是一个基本示例:

在模块mod1中:

def f_add(x, y):
    """Return sum of two input numbers. 

    Parameters
    ----------
    x : float
        First input number.
    y : float
        Second input number.

    Returns
    -------
    s : float
        Sum of two input numbers.

    See Also
    --------
    f_mul : Multiply function.
    """

f_mul位于另一个模块mod2中,f_mul See Also f_add:func:`f_mul`的正确方法是什么?

更新: MAX(insert_date)实际上有效,但在CLI中却不那么整洁。

0 个答案:

没有答案