https://github.com/heavenshell/vim-quickrun-hook-sphinx
Quickrun hook for Sphinx build
https://github.com/heavenshell/vim-quickrun-hook-sphinx
Last synced: 3 months ago
JSON representation
Quickrun hook for Sphinx build
- Host: GitHub
- URL: https://github.com/heavenshell/vim-quickrun-hook-sphinx
- Owner: heavenshell
- Created: 2012-09-08T14:42:26.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2013-03-09T11:30:25.000Z (over 13 years ago)
- Last Synced: 2025-03-06T02:12:12.553Z (over 1 year ago)
- Language: VimL
- Size: 97.7 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Quickrun hook for Sphinx build
==============================
QuickRun hook for enable to build Sphinx
Install
-------
Install the distributed files into Vim runtime directory which is usually
~/.vim/, or $HOME/vimfiles on Windows.
If you install pathogen that provided from Tim Pope, you should extract the
file into 'bundle' directory.
Usage
-----
1. Add below example QuickRun config to your `.vimrc` or `_vimrc`.
2. Open your reStructured file.
3. Run QuickRun.
4. QuickRun would execute `sphninx-build -b html -d /path/to/build/doctrees /path/to/source /path/to/build` and build.
Example QuickRun configs
------------------------
```viml
let g:quickrun_config = {}
let g:quickrun_config['rst'] = {'command': 'sphinx-build', 'hook/sphinx/enable': 1, 'cmdopt': '-b html'}
```