документация в режиме python для Emacs - PullRequest
6 голосов
/ 25 января 2012

Я только что установил режим python в Emacs, и он, кажется, работает хорошо.Однако я не смог найти документацию для пакета на официальном сайте .

. В комплект поставки входит папка doc, в которой я вижу два файла:

commands-python-mode.org
commands-python-mode.rst

Оба файла, похоже, отформатированы для какого-либо внешнего инструмента, отображающего текст справки.

С этим:

  • Есть ли инструмент, который я могу использовать для навигации по этой документации?
  • Есть ли у python-mode онлайн-сайт с документацией?Какие-нибудь учебники или хорошие пошаговые руководства по python-mode для Emacs?

Ответы [ 4 ]

8 голосов
/ 25 января 2012

Начните с M-x describe-mode.Это дает вам обзор доступных привязок клавиш.Для каждой команды используйте C-f name RET, чтобы увидеть встроенную документацию.Файл .org должен быть org-mode и легко читаемым в Emacs.

См. Также здесь

3 голосов
/ 25 января 2012

Беглый осмотр этих двух файлов и кода говорит мне, что это в основном список строк документации, найденных в pymacs.el и python-mode.el. Это означает, что вы сможете получить доступ к соответствующей документации через M-x apropos или C-h a и друзей (в частности, найдите ^py или ^pymacs, чтобы получить список функций режима).

Как правило, поскольку elisp не поддерживает пространства имен, все функции / переменные, определенные данным режимом, будут иметь согласованный префикс, связанный с именем режима. Это упрощает поиск в документации по Emacs.

1 голос
/ 19 февраля 2014

В дополнение к приведенным ответам: Попробуйте пошаговое описание меню «Питон», которое появляется в верхней части окна.Он покажет краткое описание команд или опций.

WRT для начинающих, некоторые введения, примеры базового использования могут быть приведены еще.Подали запрос на добавление:

https://bugs.launchpad.net/python-mode/+bug/1281970

1 голос
/ 29 января 2012

Если вы пользователь emacs и не слышали о org-mode до того, как вас угостят.

Откройте файл .org в emacs и перейдите в режим org ( META x org-mode), используйте TAB в строках заголовка. Заголовки начинаются с одного или нескольких символов *.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...