Содержание

1. Что это такое?
2. Установка
   1. Конфигурация
3. Использование
   1. Как выглядит работа Pysphinx

Что это такое?

Пока этот проект находится в бета-тестировании (многое не добавлено и не исправлено)

(см docs/technical_{requirements.org})

pysphinx это Emacs minor mode для вставки документации docstring в Python функции, методы, классы, данные и т.п. в формате reStructuredText (ReST), javadoc, Google doc, numpydoc

Установка

Установка пока доступна только с github (в дальнейшем добавлю в melpa)

Устанавливаем и добавляем директорию по следующему пути:

• git clone https://github.com/TheWhatis/pysphinx.git
• cp -r pysphinx ~/.emacs.d/elpa/

Конфигурация

Добавить следующие строки в свой .emacs конфиг

(add-to-list "/abspath/to/home/.emacs.d/elpa/pysphinx/") ; Абсолютный путь до пакета
(require 'pysphinx) ; Подключаем `pysphinx'
(add-hook 'python-mode-hook 'pysphinx-minor-mode) ; Примантируем к `python-mode-hook' `pysphinx-minor-mode'

Когда вы это сделаете, у вас появится комбинация клавиш C-c h - к ней привязана интерактивная функция pysphinx-put-or-delete-docstring.

С помощью неё вы сможете добавлять к вашим конструкциям шаблоны docstring

Использование

Откройте Python код, переместите курсор под функцию/метод/класс и нажмите комбинацию клавиш C-c h (см. видео ниже)

Как выглядит работа Pysphinx