使用readthedocs上模拟模块中的参数的Sphinx autodoc

Question

我们正在使用readthedocs来记录我们的开源项目pandapower。

因为pandapower依赖于numpy和其他不能在rtd上构建的C库，所以我们使用autodoc_mock_imports参数为这些库创建模拟导入。这在一般情况下是很好的，但是在以np.nan作为默认参数的函数的autodoc中会出现问题，例如这里。sn_kva参数的默认值是np.nan (参见代码中的这里 )，但是由于numpy是作为模拟模块导入的，所以它显示为"sphinx.ext.autodoc._MockModule对象“。

有人知道有可能避免这种情况吗？

Answer 1

提供想要的签名作为docstring的第一行。然后狮身人面像将在输出中使用它作为签名。见签名。

在您的示例中，函数的第一行如下所示：

def create_load(net, bus, p_kw, q_kvar=0, const_z_percent=0, const_i_percent=0, sn_kva=nan,
            name=None, scaling=1., index=None,
            in_service=True, type=None, max_p_kw=nan, min_p_kw=nan,
            max_q_kvar=nan, min_q_kvar=nan, controllable=nan):
    """
    create_load(net, bus, p_kw, q_kvar=0, const_z_percent=0, const_i_percent=0, sn_kva=nan,
                name=None, scaling=1.0, index=None,
                in_service=True, type=None, max_p_kw=nan, min_p_kw=nan,
                max_q_kvar=nan, min_q_kvar=nan, controllable=nan)

    Adds one load in table net["load"].

    ...

    """