vimbuilder 0.0.1

Sphinx extension to generate Vim help files

vimbuilder

Sphinx extension to create Vim help files.

Install

pip3 install vimbuilder

Usage

Add the extension to your conf.py file:

extensions = [
    ...,
    "vimbuilder",
    ...,
]

Build Vim help files with sphinx-build command

sphinx-build -M vimhelp ./docs ./build

Configurations

You can add the following configurations to your conf.py file:

Option	Default	Description
vimhelp_tag_prefix	''	String to prefix all tags. Useful for separating namespaces in case of multiple sources of documentation.
vimhelp_tag_suffix	''	String to suffix all tags. See above.
`vimhelp_tag_filename'	True	Whether to suffix filename to all tags in the file. Clarifies topic of help tag.
`vimhelp_filename_suffix'	';'	First tag in a help file is filename. Suffixing the filename will avoid conflict with Vim native help files.

Projects using Vimbuilder

• Python documentation for Vim and Neovim