All geek questions in one place

Python mode documentation for emacs

I just installed python-mode in Emacs and it seems to work fine. However, I could not find the documentation for the package on the official website .

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 help text.

Wherein:

  • Is there a tool that I can use to navigate this documentation?
  • Is there an online documentation site in python mode? Any tutorials or good passages for python-mode for Emacs?
+6
source share
4 answers

A quick look at these two files and the code tells me that they are basically a list of docstrings found in pymacs.el and python-mode.el . This means that you can access the relevant documentation through Mx apropos or Ch a and friends (in particular, look for ^py or ^pymacs to get a list of mode functions).

Generally, since elisp does not support namespaces, all functions / variables defined by this mode will have a consistent prefix associated with the mode name. This makes a fairly simple search in the Emacs documentation.

+3
source

Start with Mx describe-mode . This gives you an overview of the available key bindings. For each command, use Cf name RET to see the built-in documentation. The .org file should be an org-mode file and easy to read with Emacs.

See also here

+8
source

If your user emacs and did not hear about org-mode before your entrance for treatment.

Open the .org file in emacs and go to org-mode ( META x org-mode ), use TAB in the header lines. Headings begin with one or more * .

+1
source

In addition to the answers below: try going through the "Python" menu that appears at the head of the window. It will display a brief description of the commands or parameters.

WRT for beginners, some introductions, examples of basic use can be given more. Filed a function request:

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

+1
source

Source: https://habr.com/ru/post/906788/

More articles:


All Articles