Sphinx extension to generate Vim help files
Project description
vimbuilder
Sphinx extension to create Vim help files.
Converting API documentation of programming languages to Vim help format just got easier.
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_tag_topic' | False |
Same as above except without file extension. |
`vimhelp_filename_extension' | 'txt' |
Generated filenames will have this extension. |
`vimhelp_filename_suffix' | '' |
First tag in a help file is the filename itself. This adds a suffix to just that tag. |
Projects using Vimbuilder
- Python documentation for Vim and Neovim
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
vimbuilder-0.0.3.tar.gz
(201.8 kB
view hashes)
Built Distribution
Close
Hashes for vimbuilder-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f6183f16c711f3079b785723681677ce2c4b1bc170d431487d0ebd996188fd0 |
|
MD5 | 529dea69225b4f0c6b13bbf686617086 |
|
BLAKE2b-256 | bdb922dc9bbbaa1ab6b9f7965af4bce2828986bdb2982c899da3804e8444ee9b |