如何在PyCharm中检索扩展模块的文档?

时间:2019-05-27 23:52:54

标签: python pycharm documentation python-extensions

因此,我做了一个Python扩展,并成功地建立了*.pyd文件efficient.pyd,具体来说。

现在,我像其他模块一样将其导入PyCharm中:

import efficient
x = efficient.add(2,3)

,它可以正常工作。问题是,当我尝试使用Ctrl + Q检索efficient.add函数的文档时,即使我在*.c文件中提供了一个文档字符串,PyCharm也会说“找不到文档”:

static PyMethodDef EfficientMethods[] = {
    {"add",  efficient_add, METH_VARARGS, "Add two integers"},
    {NULL, NULL, 0, NULL}
};

期望的行为

当我使用Ctrl + Q提取numpy.array的文档时,它就像一个超级按钮:

numpy_docs

我应该怎么做才能在efficient.add上按Ctrl + Q后看到“加两个整数”? 可选地,如果有一种简单的方法可以在PyCharm中为C扩展名添加类型提示,那么它也会很好(就像上面的示例一样)。

我尝试过的

我相信可以通过 Settings>工具> Python外部文档来实现,但是我不知道外部文档文件应该是哪种格式,或者在上述 Python外部文档。 我尝试将模块名称设置为efficient,并将 URL /路径模式设置为efficient.docs文件的路径,该文件具有以下内容:

def add(x, y):
    """ Add two integers """
    pass

但是不幸的是,这不起作用。

0 个答案:

没有答案