https://github.com/sphinx-contrib/vimbuilder
Sphinx extension to add Vim help file generation support
https://github.com/sphinx-contrib/vimbuilder
documentation-tool sphinx-extension vim vim-help
Last synced: 12 months ago
JSON representation
Sphinx extension to add Vim help file generation support
- Host: GitHub
- URL: https://github.com/sphinx-contrib/vimbuilder
- Owner: sphinx-contrib
- License: mit
- Created: 2023-09-08T14:27:05.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-15T14:54:20.000Z (over 2 years ago)
- Last Synced: 2025-02-08T13:51:14.305Z (about 1 year ago)
- Topics: documentation-tool, sphinx-extension, vim, vim-help
- Language: Python
- Homepage:
- Size: 202 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vimbuilder
Sphinx extension to create Vim help files.
Converting API documentation of programming languages to Vim help format just
got easier.
## Install
```sh
pip3 install vimbuilder
```
## Usage
Add the extension to your `conf.py` file:
```python
extensions = [
...,
"vimbuilder",
...,
]
```
Build Vim help files with `sphinx-build` command
```sh
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 option adds a suffix to just that tag.
## Projects using Vimbuilder
- [Python documentation](https://github.com/girishji/pythondoc.vim) for Vim and Neovim