---

Ⅰ. 插件描述

Quickrun hook for Sphinx build

Ⅱ. 基本信息

创建日期：  2012-09-08 使用用户：  1 Github星：  2 插件作者：  Shinya Ohyanagi

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'heavenshell/vim-quickrun-hook-sphinx'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'heavenshell/vim-quickrun-hook-sphinx'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'heavenshell/vim-quickrun-hook-sphinx'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/heavenshell/vim-quickrun-hook-sphinx

Ⅳ. 文档说明

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

let g:quickrun_config = {}
let g:quickrun_config['rst'] = {'command': 'sphinx-build', 'hook/sphinx/enable': 1, 'cmdopt': '-b html'}