Question

NB：How to document Parameter of type 'function' in sphinx?的可能重复项。重新询问适当的MWE和更多信息，但不足以作为答案。随时合并或其他内容。

使用Sphinx生成文档时，指定函数的参数和返回类型可通过autodoc和intersphinx自动链接它们。如何指定函数类型？

def do_something(some_integer, some_string, some_function):
    '''Do something.

    Args:
        some_integer (int): is an integer
        some_string (str): is a string
        some_function (???): is a function
    '''
    ...

会生成指向https://docs.python.org/2/library/functions.html#int和https://docs.python.org/2/library/functions.html#str的链接（带有指向Python 2文档的狮身人面像设置）。用什么???替换为链接到https://docs.python.org/2/library/types.html#types.FunctionType（或另一个合适的位置）的链接？

部分解决方法

在可以使用的地方

:py:class:`int` / :py:class:`str`

您可以通过以下方式获得所需的链接

:py:data:`types.FunctionType`

我是通过检查$ python -msphinx.ext.intersphinx https://docs.python.org/2/objects.inv创建的库存对象来确定这一点的。

该解决方法适用于编写自由流动的文本，但不适用于docstring类型声明（我认为Sphinx在解析文本时会自动附加:class:角色）。在清单对象中，py:class下没有真正匹配的东西。

我想唯一的选择是用手摆弄库存物品，但是（1）它不干净，并且（2）也许有一个原因（我不知道） Python提供的清单对象省略了函数类。

Sphinx文档：功能类型

0 个答案: