GitXplorerGitXplorer
g

PythonDocs

public
2 stars
0 forks
1 issues

Commits

List of commits on branch main.
Verified
2d77f325fed7e64611561aa639a664bf7bf6631d

update installation instructions

ggwenzek committed 3 years ago
Unverified
8c471d47c93abbe5d96927228db30e750fb122d7

add cpython docs in hyperhelp format

ggwenzek committed 4 years ago
Unverified
63dcb58ac8d255cbfe511885712f3a53cc9f7237

big cleanup, remove conversion code

ggwenzek committed 4 years ago
Unverified
ec417018dd03ad17420941da576fde03c1ddbeca

add Makefile to install the package easily

ggwenzek committed 4 years ago
Unverified
299a1716cd8d4a919cabf363900740eb50179bf4

force hyperhelp to reload PythonDocs if needed

ggwenzek committed 5 years ago
Unverified
430f2153ab437c41e5ac64800370f0487a382717

fetch rst files from CPython sources

ggwenzek committed 5 years ago

README

The README file for this repository.

PythonDocs

Browse docs.python.org inside Sublime Text

This package leverage HyperHelp to show Python documentation from Sublime. The conversion between reStructuredText (used for Python docs) and HyperHelp format, is done using my own Sphinx plugin.

License

This plugin is released under the BSD-3-Clause.

This plugin is distributing a transformed version of cpython documentation. The cpython documentation is distributed under it's own license, which is also readable from Sublime Text.

Get started

  • First make this package and dependencies visible to Package Control
  • Install this package
    • Command Palette: Package Control: Install Package > PythonDocs
    • Restart Sublime Text
  • Test it through Command Palette
    • Command Palette: HyperHelp: Browse available Help > PythonDocs > pathlib
    • This should open a new view showing pathlib documentation
    • Try navigating by using tab, enter
  • Add keybindings
    • !!! Command is currently broke, need fix !!!
    • Command Palette: Preferences: Key Bindings
    • Insert {"keys": ["f1"], "command": "python_docs_open", "context": [{"key": "selector", "operator": "equal", "operand": "source.python"}]},
    • Save and exit the key bindings view
    • Open a python file. Type pathlib, press F1. It should open the pathlib HyperHelp.
    • Type F1 anywhere in your python code to open the HyperHelp search box prefilled with the text under cursor.