python-mode documentation for Emacs

Question

I just installed the python-mode in Emacs and it seems to be working well. However, I could not find documentation for the package on the official site.

The package comes with a doc folder where I can see two files:

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

Both files seem to be formatted for some external tool that displays the help text.

With this:

• Is there a tool I can use to navigate this documentation?
• Does python-mode have an online site with documentation? Any tutorials or good walk-throughs for python-mode for Emacs?

Answer 1

Start off with M-x describe-mode. This gives you an overview over the available key bindings. For each command use C-f name RET to see the built-in documentation. The .org file should be an org-mode file and easily readable with Emacs.

See also here

Answer 2

A cursory inspection of those two files and the code tells me that they're basically a listing of the docstrings found in pymacs.el and python-mode.el. That means you'll be able to access the relevant documentation through M-x apropos or C-h a and friends (specifically, search for ^py or ^pymacs to get a listing of the mode functions).

As a general rule, because elisp doesn't support namespaces, all functions/variables defined by a given mode will have a consistent prefix related to the name of the mode. That makes it fairly simple to search through the Emacs documentation.

Answer 3

If your a emacs user and haven't heard of org-mode before your in for treat.

Open the .org file in emacs and go to org-mode (METAxorg-mode), use TAB on the header lines. Header-lines starts with one or more *.