Спеціальні заглушки для документації PyCharm (тобто для форматів документації Google або numpydoc)


75

Чи підтримує PyCharm 2.7 (чи PyCharm 3) підтримує власні таблиці та док-тести? Якщо так, то як можна писати цей конкретний тип спеціального розширення?

Мій поточний проект стандартизував використання Посібника зі стилів 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, з двома іншими типами документації.


Відповіді:


102

За допомогою PyCharm 5.0 ми нарешті вибрали шаблони Google і NumPy у стилі Python Docstrings .

Це також згадується у новому розділі PyCharm 5.0.

Як змінити формат Docstring:

Файл -> Налаштування -> Інструменти -> Інтегровані інструменти Python

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

Звичайний, Epytext, reStructuredText, NumPy, Google

Як зазначив jstol: для користувачів Mac це менше

PyCharm -> Налаштування -> Інструменти -> Інтегровані інструменти Python.


8
Для користувачів Mac це знаходиться під PyCharm -> Налаштування -> Інструменти -> Інтегровані інструменти Python.
jstol

3
Будь-яка ідея, як змусити цей вибір дотримуватися, коли я починаю новий проект? Це біль, коли доводиться щоразу вистежувати цю обстановку.
superbeck

1
Подумайте про оновлення цієї відповіді, щоб включити інформацію до коментаря від jstol
Kane C


1

Просто для того, щоб зробити відповідь @Nras явною, станом на PyCharm 5.0 :

Файл> Налаштування> Інструменти> Інтегровані інструменти Python> Документи> Google

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.