如何让epydoc在函数原型中显示参数？

Question

使用epydoc，版本3.0.1。

我试过这个简单的方法：

def SetNetwork(self, PyLabNetwork net):
    """
    Set the net !!!
    @param self: How long they should think.
    @type self: C{int} or L{PyLabNetwork}
    @param net: How long they should think.
    @type net: C{int} or L{PyLabNetwork}
    """
    self.network = net

运行以下命令：

epydoc -v -o ./html --name epydoc --css white --docformat epytext cyelp

但在epydoc生成的html中，方法原型仍然以3个连续的点出现，而不是所描述的参数：

SetNetwork(...) << ??? NOTHING INSIDE ???

Set the net !!!

Parameters:

        self (int or PyLabNetwork) - How long they should think.
        net (int or PyLabNetwork) - How long they should think.

有什么想法吗？非常感谢

编辑:对不起，我刚刚测试了一个简单的脚本，它工作得很好。前一种情况不起作用，因为它是用Cython编译的共享对象(.so)。这会有所不同。信号源也不能显示。我以为epydoc只在文档字符串上工作，关于函数原型的解析，但它似乎比这要复杂一点……

EDIT2 :此外，如果我编译时将"embedsignature“cython编译指令传递给"True"，我会得到一些东西--这仍然是错误的，但我更好地理解了这种现象：

SetNetwork(...)


PyLabNode.SetNetwork(self, PyLabNetwork net)

Set the net !!!

Parameters:

        self (int or PyLabNetwork) - How long they should think.
        net (int or PyLabNetwork) - How long they should think.

又名: epydoc不理解cythonized签名的嵌入方式……

如果你有更具体的解释，我仍然是你的人。谢谢

Answer 1

明白了。

我删除了cython编译指令，该指令发送epydoc无法理解的签名，如下所示：

PyLabNode.SetNetwork(self, PyLabNetwork net)

这有两个缺点:类前缀的点符号和类型化的参数。

并将其替换为格式良好的python，作为doc字符串的第一行，如下所示：

def SetNetwork(self, PyLabNetwork net):
    """
    SetNetwork(self, net)
    Set the net !!!
    @param self: Handler to this.
    @type self: L{PyLabNode}
    @param net: The network this node belongs to.
    @type net: L{PyLabNetwork}
    """
    self.network = net

这就起到了作用。希望这能对一些人有所帮助。