Emacs的Python-mode文档

Question

我刚刚在Emacs中安装了python-mode，它似乎运行良好。然而，在官方网站上找不到这个软件包的文档。该软件包带有一个“doc”文件夹，其中可以看到两个文件：

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

这两个文件似乎是为某个外部工具格式化了帮助文本。

有以下几点需要注意：

• 是否有工具可以用来浏览这份文档？
• Python-mode是否有在线文档站点？有没有针对Emacs中Python-mode的教程或指南？

- Amelio Vazquez-Reina

Answer 1

首先使用M-x describe-mode命令，了解可用的按键绑定。对于每个命令，请使用C-f name RET查看内置文档。该.org文件应该是一个org-mode文件，并且可以在Emacs中轻松阅读。

另请参见此处

- pmr

Answer 2

一次简单的检查这两个文件和代码告诉我，它们基本上是列出了pymacs.el和python-mode.el中发现的docstrings。这意味着您可以通过M-x apropos或C-h a等方式访问相关文档（具体来说，搜索^py或^pymacs以获取模式函数列表）。

作为一般规则，由于elisp不支持命名空间，所有由给定模式定义的函数/变量都将具有与模式名称相关的一致前缀。这使得在Emacs文档中进行搜索相当简单。

- Inaimathi

Answer 3

除了现有的回答外：尝试使用出现在窗口顶部的“Python”菜单的演示。它将显示命令或选项的简短描述。

对于初学者，可以给出一些介绍和基本用法的示例。 已提交功能请求：

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

- Andreas Röhler

Answer 4

如果你是一个使用emacs的用户，而且之前没有听说过org-mode，那么你就有福了。

在emacs中打开.org文件并进入org-mode（METAxorg-mode），在标题行上使用TAB。标题行以一个或多个*开头。

- Johan