---

Ⅰ. 插件描述

A simple script to help create ctags-compatible tag files for the sections within a reStructuredText document.

Ⅱ. 基本信息

创建日期：  2013-08-29 使用用户：  4 Github星：  25 插件作者：  John Szakmeister

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'jszakmeister/rst2ctags'

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

:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'jszakmeister/rst2ctags'

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

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'jszakmeister/rst2ctags'

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

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/jszakmeister/rst2ctags

Ⅳ. 文档说明

*
rst2ctags

---

This application generates ctags-compatible output for the sections of a
reStructuredText document. It does not use the docutils engine since docutils
is far too slow for my needs.

The motivation was to have a tool fast enough to use with the `TagBar
https://github.com/majutsushi/tagbar`_ plugin in Vim.

Using with TagBar

To use this tool with TagBar, add the following into your ~/.vimrc::

" Add support for reStructuredText files in tagbar.
let g:tagbar_type_rst = {
    \ 'ctagstype': 'rst',
    \ 'ctagsbin' : '/path/to/rst2ctags.py',
    \ 'ctagsargs' : '-f - --sort=yes --sro=»',
    \ 'kinds' : [
        \ 's:sections',
        \ 'i:images'
    \ ],
    \ 'sro' : '»',
    \ 'kind2scope' : {
        \ 's' : 'section',
    \ },
    \ 'sort': 0,
\ }

License

This tool is licensed under a Simplified BSD license. See LICENSE.txt for
details.