自动导入文档字符串中的某些内容

时间:2018-07-18 05:10:34

标签: python documentation python-sphinx doctest

我正在寻找自动导入文档字符串中某些内容的方法。例如,考虑以下代码:

def useless_func(arrays):
    """
    Passes through the arrays parameter.

    Parameters
    ----------
    arrays : List[np.ndarray]
        The input.

    Returns
    -------
    arrays : List[np.ndarray]
        The output.

    Examples
    --------
    >>> a = [np.arange(5)]
    >>> arrays(a)
    <some_output>
    """
    return arrays

现在,要在构建的文档中真正起作用,我需要以某种方式from typing import List; import numpy as np在文档字符串中是隐式的(我正在使用Sphinx和intersphinx)。具体来说,我希望Intersphinx可以正确链接到ndarrayList,甚至还可以在许多地方使用一些内部API文档。

另外,对于doctest(我正在使用pytest doctest运行程序),我需要一种方法来指定import numpy as np是隐式的。如果我运行它,则在未导入NumPy或未使用其他名称导入NumPy的情况下,在第一个示例行上都会显示一个NameError

有标准的方法可以做到吗?

0 个答案:

没有答案