ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Py​DOC

by chrissimpkins ST2/ST3

A Sublime Text plugin that supports Python 2 & 3 documentation search from selections in the editor

Details

Installs

  • Total 5K
  • Win 2K
  • OS X 1K
  • Linux 2K
Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7 Jun 6
Windows 1 0 0 0 0 2 0 0 0 0 2 2 6 0 1 0 2 0 1 2 0 0 0 0 0 1 1 1 1 1 1 0 1 2 0 1 2 1 2 2 3 0 1 1 0 4
OS X 0 1 1 0 0 0 0 0 0 5 0 0 0 1 0 2 0 0 0 0 0 0 2 0 1 2 0 0 0 0 0 0 0 1 1 1 2 0 2 0 0 1 2 1 0 1
Linux 0 0 0 1 1 1 0 1 1 0 1 0 0 0 0 1 1 2 1 0 0 0 0 0 2 1 1 1 1 0 1 0 1 1 3 1 0 0 3 2 1 0 0 1 1 1

Readme

Source
raw.​githubusercontent.​com

PyDOC

A Sublime Text 2/3 plugin that supports Python documentation search from selections in the editor.

About

PyDOC allows you to search Python 2 or Python 3 documentation on http://docs.python.org for built-in Python modules, classes, methods, and functions that are selected in the Sublime Text editor. A browser window is launched (in your default browser), using your selected text as the query term for the Python 2 or Python 3 documentation.

By default, the most recent Python 2 or Python 3 release documentation is used.

Install PyDOC

Using Sublime Package Control

PyDOC can be installed using Sublime Package Control. Open the command palette with:

Mac OSX
Cmd + Shift + P
Linux & Windows
Ctrl + Shift + P

Type install and select the menu item, Package Control: Install Package.

Type PyDOC and select the PyDOC package that is displayed. This will install the package in your editor.

Using Git

Use the Sublime Text menu items Preferences -> Browse Packages to locate your Packages directory.

Navigate to the directory in your terminal and clone the PyDOC source repository inside the Packages directory using the command:

git clone https://github.com/chrissimpkins/PyDOC.git "PyDOC"

Manual Install

Download the zip compressed archive from GitHub.

Decompress the zip archive and rename the directory PyDOC.

Open your Sublime Text Packages directory using the Preferences -> Browse Packages menu items.

Move the entire PyDOC directory into your Sublime Text Packages directory.

Use PyDOC

Search with Right Click Menu

Select a built-in Python object in your editor text, then use the Python 2 Doc Search or Python 3 Doc Search menu item in the right click menu.

Search with Keybinding

Select a built-in Python object in your editor text, then use one of the following keybindings to perform the search:

Python 2 Documentation Search Keybinding
Ctrl-2
Python 3 Documentation Search Keybinding
Ctrl-3

Search with the Command Palette

Select a built-in Python object in your editor text then enter the keybinding to open the command palette (see description above in the Sublime Package Control section). Type 'pydoc' and then select either Python 2 Doc Search (PyDOC) or Python 3 Doc Search (PyDOC).

Issues

Having a problem? Let's fix it. Here are a few steps that will lead to the most rapid fix:

  1. Make sure that you selected text in the editor before attempting to use PyDOC. It's not that good (yet…).

  2. Open the Sublime Text console with Ctrl-` or View -> Show Console, then run PyDOC again. It generally provides helpful hints for problems and any exceptions that are raised will be displayed.

  3. Submit the issue on the GitHub repository with as much detail as you can provide. Please paste the console ouptut for any exceptions that are raised.

Changes

v.1.2.3 - added PyDOC to main menu for access to README and keybindings

v1.2.2 - updated user status and error messages, added install docs

v1.2.1 - added horizontal bar dividers to the context menu

v.1.2.0 - updated Python 2 & 3 URL handling

v1.1.1 - modified ST3 URL encoding (Python 3)

v.1.1.0 - modified ST2 URL encoding (Python 2)

v.1.0.1 - updated menu items

v1.0.0 - initial release

License

MIT License