cgit.sxemacs.org Git - packages/blob - xemacs-packages/python-modes/pydoc-el-README

   1 # SUMMARY:      README for pydoc.el emacs interface to Python pydoc.
   2 #
   3 # AUTHOR:       Bob Weiner
   4 # ORG:          Deepware
   5 #
   6 # ORIG-DATE:    23-Apr-01 at 00:03:37
   7 # LAST-MOD:     23-Apr-01 at 00:16:15 by Bob Weiner
   8 #
   9 # Copyright (C) 2001  Bob Weiner
  10 # Licensed under the Python license version 2.0 or higher.
  11 #
  12 # DESCRIPTION:
  13
  14 pydoc.el is an Emacs/XEmacs/InfoDock interface to the Python pydoc system.
  15 It provides convenient integration with powerful programming editors,
  16 speeding both Python learning and day-to-day access of reference
  17 documentation while programming.
  18
  19 For installation information, see the DESCRIPTION section in "pydoc.el".
  20
  21 ----
  22
  23 pydoc.el adds one new global key binding, {C-c M-h} (pydoc-commands) which
  24 displays a menu of commands for interacting with pydoc.  It is global so
  25 you may examine Python documentation whenever needed, regardless of whether
  26 you have a Python code buffer on screen.
  27
  28 The following commands are available, each invoked by typing the first
  29 character of the command name when prompted with the menu.
  30
  31 A)propos <term>    - list modules/packages with <term> in their first line doc strings
  32 H)elp <term>       - display doc for name <term> or string literal '<term>'
  33 K)eyword <keyword> - with completion, display doc for a Python <keyword>
  34 M)odule <name>     - with completion, display doc for a Python module <name>
  35 P)ackage <name>    - with completion, display doc for a Python package <name>
  36 T)opic <topic>     - with completion, display Python reference doc for <topic>
  37 X)ref <term>       - with completion, display doc for a pydoc cross-reference
  38                      within a Python reference manual section
  39
  40 ?   - show the above help
  41 C-g - abort from menu
  42
  43 # DESCRIP-END.
  44