Skip to main content

Generates ctags-compatible output for the sections of a reStructuredText document.

Project description

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 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rst2ctags-0.2.3.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rst2ctags-0.2.3-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file rst2ctags-0.2.3.tar.gz.

File metadata

  • Download URL: rst2ctags-0.2.3.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for rst2ctags-0.2.3.tar.gz
Algorithm Hash digest
SHA256 cad9d3cade488dd6da11b1c4b2dcdc35d2563be6e729c0de2eac1c0a422d3f9a
MD5 5497538d4116fe8d166a49778de69363
BLAKE2b-256 155ee86144de8caf0c27be0a5be22442457b6e4aeb5dd0b0d7161a7e73dafc22

See more details on using hashes here.

File details

Details for the file rst2ctags-0.2.3-py2.py3-none-any.whl.

File metadata

  • Download URL: rst2ctags-0.2.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for rst2ctags-0.2.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d2f24ca37bd9202d8024781f09c979bbd0d7324cf26f675dfd47bc0af229803b
MD5 e4c9c2450bc7166ae55c3a806e275f58
BLAKE2b-256 fcae26b114fa4cd2e03c1f419e2fc43f6a8b716ab1a5078484bef17e6dc2c5c0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page