Metadata-Version: 2.1
Name: vimbuilder
Version: 0.0.1
Summary: Sphinx extension to generate Vim help files
Project-URL: Homepage, https://github.com/girishji/vimbuilder
Project-URL: Bug Tracker, https://github.com/girishji/vimbuilder/issues
Author-email: Girish Palya <girishji@gmail.com>
License-File: LICENSE
Keywords: builder,docs,documentation,sphinx,sphinx-extention,vim,vim-help
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# vimbuilder

Sphinx extension to create Vim help files.

## 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_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](https://github.com/girishji/pythondoc.vim) for Vim and Neovim
