# 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
Raw data
{
"_id": null,
"home_page": "",
"name": "vimbuilder",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "builder,docs,documentation,sphinx,sphinx-extention,vim,vim-help",
"author": "",
"author_email": "Girish Palya <girishji@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/66/e6/49cb27abcf6662a07ecea441c912246f09f5aaad88810eb0563bcfc46869/vimbuilder-0.0.4.tar.gz",
"platform": null,
"description": "# vimbuilder\n\nSphinx extension to create Vim help files.\n\nConverting API documentation of programming languages to Vim help format just\ngot easier.\n\n## Install\n\n```sh\npip3 install vimbuilder\n```\n\n## Usage\n\nAdd the extension to your `conf.py` file:\n```python\nextensions = [\n ...,\n \"vimbuilder\",\n ...,\n]\n```\n\nBuild Vim help files with `sphinx-build` command\n\n```sh\nsphinx-build -M vimhelp ./docs ./build\n```\n\n## Configurations\n\nYou can add the following configurations to your `conf.py` file:\n\nOption|Default|Description\n------|-------|-----------\n`vimhelp_tag_prefix`|`''`|String to prefix all tags. Useful for separating namespaces in case of multiple sources of documentation.\n`vimhelp_tag_suffix`|`''`|String to suffix all tags. See above.\n`vimhelp_tag_filename`|`True`|Whether to suffix filename to all tags in the file. Clarifies topic of help tag.\n`vimhelp_tag_topic`|`False`|Same as above except without file extension.\n`vimhelp_filename_extension`|`'txt'`|Generated filenames will have this extension.\n`vimhelp_filename_suffix`|`''`|First tag in a help file is the filename itself. This option adds a suffix to just that tag.\n\n## Projects using Vimbuilder\n\n- [Python documentation](https://github.com/girishji/pythondoc.vim) for Vim and Neovim\n",
"bugtrack_url": null,
"license": "",
"summary": "Sphinx extension to generate Vim help files",
"version": "0.0.4",
"project_urls": {
"Bug Tracker": "https://github.com/girishji/vimbuilder/issues",
"Homepage": "https://github.com/girishji/vimbuilder"
},
"split_keywords": [
"builder",
"docs",
"documentation",
"sphinx",
"sphinx-extention",
"vim",
"vim-help"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2662449aa1a381e35f3b71db98c4a45a890af59cc0225f3cc4e2a06c46017899",
"md5": "fcd8a1cd499591bb30a276de15204d63",
"sha256": "e1be4e516c397278b9af4c219f1cbbcbb323f9c9a6e0e07d67467d06215bfbbb"
},
"downloads": -1,
"filename": "vimbuilder-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fcd8a1cd499591bb30a276de15204d63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4857,
"upload_time": "2023-09-15T14:55:35",
"upload_time_iso_8601": "2023-09-15T14:55:35.986332Z",
"url": "https://files.pythonhosted.org/packages/26/62/449aa1a381e35f3b71db98c4a45a890af59cc0225f3cc4e2a06c46017899/vimbuilder-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66e649cb27abcf6662a07ecea441c912246f09f5aaad88810eb0563bcfc46869",
"md5": "5f75d9e1bcf6007cce2f5e113cbc31c5",
"sha256": "dc955a5d83baccfa194abd8255f085458770a971aa8d6613b68c5a96b26d689a"
},
"downloads": -1,
"filename": "vimbuilder-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "5f75d9e1bcf6007cce2f5e113cbc31c5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 201767,
"upload_time": "2023-09-15T14:55:37",
"upload_time_iso_8601": "2023-09-15T14:55:37.939902Z",
"url": "https://files.pythonhosted.org/packages/66/e6/49cb27abcf6662a07ecea441c912246f09f5aaad88810eb0563bcfc46869/vimbuilder-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-15 14:55:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "girishji",
"github_project": "vimbuilder",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "vimbuilder"
}
JSON
