Как получить документы модуля расширения в PyCharm? - PullRequest
Новая
       27

Как получить документы модуля расширения в PyCharm?

0 голосов
/ 28 мая 2019

Итак, я сделал расширение Python и успешно создал файл *.pyd, efficient.pyd, если быть точным.

Теперь я импортирую его в PyCharm, как и любые другие модули: 

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

и работает как надо. Проблема в том, что когда я пытаюсь получить документацию по функции efficient.add с помощью Ctrl + Q, PyCharm сообщает «Документация не найдена», хотя я предоставил строку документации в файле *.c: 

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

Желаемое поведение

Когда я извлекаю документацию по numpy.array с помощью Ctrl + Q, она работает как шарм:

numpy_docs

Что я должен сделать, чтобы увидеть "Добавить два целых числа" после Ctrl + Q на efficient.add? Необязательно, если есть простой способ добавить подсказку типа для расширения C в PyCharm, это также будет хорошо (как в примере выше).

Что я пробовал

Я полагаю, что это может быть достигнуто с помощью Настройки> Инструменты> Внешняя документация Python , но я понятия не имею, как должен выглядеть внешний файл документации или как его настраивать в упомянутом Внешняя документация Python . Я попытался установить Имя модуля на efficient и URL / Шаблон пути на путь к файлу efficient.docs, который имеет следующее содержимое: 

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

Но, к сожалению, это не работает.

...