Я работаю над проектом, который требует документации Numpy. В мои дни Java я помню, что у вас есть линтеры, которые проверяли приверженность Javadoc в Eclipse/IDEA; существует ли эквивалент, который проверяет соответствие стиля документации Numpy?Можно ли использовать файл Python для проверки соблюдения стиля документации в формате Numpy?
Я знаю о PEP257, но он, похоже, не имеет каких-либо конкретных проверок документации Numpy.
Pylint, похоже, поддерживает это. Взгляните на pylint.extensions.docparams.
Подводя итоги. Вы активизируете эту шашку в pylint путем добавления
load-plugins=pylint.extensions.docparams
в Генеральном разделе вашего .pylintrc.
Эта шашка проверяет, что все функции, способ и конструкторскими строки документации включают документацию
параметров в и их типы
возвращаемого значения и его тип
исключений поднято
На самом деле pydocstyle (ранее pep257) recently added support для Numpy конвенции строка документации. Хотя, это не идеально, я думаю, что это ближе всего к тому, чего вы хотите достичь, и это, вероятно, улучшится в ближайшем будущем.
pydocstyle --convention=numpy example.py
, что шашка может обрабатывать NumPy (в том числе таких, как сфинкс) стиль и проверить эти вещи, но я не думаю, что есть способ дифференцировать его от других стилей. Например, если вы пишете код с документацией Sphinx, в которой linter все равно скажет, что все в порядке, даже если вам нужен только стиль numpy - я не вижу способа указать стиль эксклюзивной документации – Andrew
@ Андрю, хм, жаль, кажется, я пропустил чтобы принять во внимание ту часть приверженности, я обновил свой ответ. –