Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/girishji/pythondoc.vim
Python API documentation for Vim and Neovim
https://github.com/girishji/pythondoc.vim
neovim pydoc python-documentation python3 vim
Last synced: 6 days ago
JSON representation
Python API documentation for Vim and Neovim
- Host: GitHub
- URL: https://github.com/girishji/pythondoc.vim
- Owner: girishji
- License: mit
- Created: 2023-09-08T18:56:40.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T07:29:25.000Z (25 days ago)
- Last Synced: 2024-10-25T15:14:47.868Z (24 days ago)
- Topics: neovim, pydoc, python-documentation, python3, vim
- Language: Vim Script
- Homepage:
- Size: 4.49 MB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pythondoc - Python Documentation Browser for Vim/Neovim
Access the complete Python official API documentation directly within your editor. Search, browse, and autocomplete Python API documentation using Vim's native `:help` and `:helpgrep` commands.
## Features
- Browse [official Python API documentation](https://docs.python.org/3/) without leaving your editor
- Search function signatures, example code, topics, tutorials, and howto guides
- Comprehensive tags database for precise documentation lookup
- High-quality documentation comparable to [Dash](https://kapeli.com/dash) or [Zeal](https://zealdocs.org/)
- Full integration with Vim's help system
[](https://asciinema.org/a/vRjU8x5KjkES4RX5BLJixqcQj)
Demo uses [vimsuggest](https://github.com/girishji/vimsuggest) for autocompletion.
## Requirements
- Vim or Neovim
## Installation
Install via [vim-plug](https://github.com/junegunn/vim-plug), [lazy](https://github.com/folke/lazy.nvim) or Vim's built-in package manager.
Show installation instructions
### Using vim-plug
Add to your `.vimrc`:
```vim
call plug#begin()
Plug 'girishji/pythondoc.vim'
call plug#end()
```
### Using Neovim's [Lazy](https://github.com/folke/lazy.nvim)
Add to your Lua config:
```lua
require("lazy").setup({
{ "girishji/pythondoc.vim", opts = {} },
})
```
### Using Vim's built-in package manager
#### Linux
```bash
git clone https://github.com/girishji/pythondoc.vim.git $HOME/.vim/pack/downloads/opt/pythondoc.vim
```
Then add this line to your _vimrc_ file:
```vim
packadd vimsuggest
```
#### Windows
```bash
git clone https://github.com/girishji/pythondoc.vim.git %USERPROFILE%\vimfiles\pack\downloads\opt\pythondoc.vim
```
Then add this line to your _vimrc_ file:
```vim
packadd vimsuggest
```
## Basic Usage
### Core Commands
```vim
:help " Access all helpfiles (Python and Vim)
:Help " Python-specific documentation
```
### Quick Customization Guide
1. Enable shorthand `:h` command:
```vim
" In vimrc
let g:pythondoc_h_expand = 1
```
2. Add keyboard shortcut for cursor word lookup:
```vim
" In ftplugin/python.vim
exe 'nnoremap dK :Help '..nr2char(&wildcharm)
```
### Tag Format
- Python tags include `@py` suffix in Vim (unless `helplang` is set to `py`)
- Makes Python documentation easily distinguishable
- Format: `function()..topic.pyx` (Open the topic by typing `:h topic.pyx`)
## For Maintainers
The help files are generated from the official Python repository using the [official tool](https://www.sphinx-doc.org/en/master/) and [extension](https://github.com/girishji/vimbuilder).
Here are the steps to generate help files:
1. **Setup:**
```bash
# Clone repositories
git clone https://github.com/girishji/pythondoc.vim
mkdir tmp
git clone https://github.com/python/cpython tmp/
```
2. **Create Python Environment:**
```bash
cd pythondoc.vim/tmp/cpython/Doc
make venv
```
3. **Configure Build:**
- Add "vimbuilder" to `requirements.txt`
- Set in conf.py: `vimhelp_filename_extension = 'pyx'`
- Modify Doc/Makefile:
- Add 'vimhelp' target (similar to 'html' or 'text')
- Optional: Comment out Blurb/NEWS lines to avoid harmless errors
4. **Prepare Documentation:**
- Rename howto/*.rst files: prepend 'howto-'
- Update references in (to reflect change of file name):
- howto/howto-index.rst
- content.rst
5. **Generate Documentation:**
```bash
make vimhelp
cp build/vimhelp/{library,howto}/*.pyx _doc/doc/
vim "+helptags ./_doc/doc | q"
```
This plugin is maintained for personal use but aims to stay current with Python releases.