Пользовательские заглушки строк документации PyCharm (например, для форматов строки документации Google или numpydoc)

Поддерживает ли PyCharm 2.7 (или будет ли PyCharm 3) пользовательские строки документации и заглушки doctest? Если да, то как написать этот конкретный тип пользовательского расширения?

В моем текущем проекте стандартизировано использование Руководства по стилю Google Python (http://google-styleguide.googlecode.com/svn/trunk/pyguide.html). Мне нравится поддержка строк документации в PyCharm, но сейчас поддерживаются только два формата: epytext и reStructureText. Я хочу и готов сам написать плагин PyCharm, который создает заглушку комментариев к документации, отформатированную в стиле Google или Numpydoc (https://pypi.python.org/pypi/sphinxcontrib-napoleon/). Особое значение здесь имеет включение возможностей вывода типов, которые PyCharm имеет с двумя другими типами документации.


person kalefranz    schedule 06.09.2013    source источник
comment
Похоже на youtrack.jetbrains.com/issue/PY-9795.   -  person CrazyCoder    schedule 07.09.2013


Ответы (3)


В PyCharm 5.0 мы, наконец, смогли выбрать строки документации Python в стиле Google и NumPy шаблоны.

Он также упоминается в разделе whatsnew для PyCharm 5.0.

Как изменить формат строки документации:

Файл --> Настройки --> Инструменты --> Интегрированные инструменты Python

Там вы можете выбрать один из доступных форматов Docstrings:

Обычный, эпитекст, реструктурированный текст, NumPy, Google

Как указывает jstol: для пользователей Mac это находится под

PyCharm -> Настройки -> Инструменты -> Интегрированные инструменты Python.

person Nras    schedule 03.11.2015
comment
Для пользователей Mac это находится в PyCharm -> Настройки -> Инструменты -> Интегрированные инструменты Python. - person jstol; 26.07.2016
comment
Любая идея, как сделать этот выбор закрепленным, когда я начинаю новый проект? Больно каждый раз выискивать этот параметр. - person superbeck; 01.09.2017
comment
Рассмотрите возможность обновления этого ответа, чтобы включить информацию в комментарий от jstol. - person Kane C; 06.03.2018

Как упоминает CrazyCoder, это билет. Сейчас вы можете использовать только EpyType и reStructuredText.

person Games Brainiac    schedule 14.10.2013

Просто чтобы сделать ответ @Nras явным, начиная с PyCharm 5.0 :

Файл> Настройки> Инструменты> Интегрированные инструменты Python> Строки документации> Google

person Kamil Sindi    schedule 27.12.2015