{"id":19931050,"url":"https://github.com/sphinx-contrib/vimbuilder","last_synced_at":"2026-05-09T20:24:54.483Z","repository":{"id":193531741,"uuid":"688986779","full_name":"sphinx-contrib/vimbuilder","owner":"sphinx-contrib","description":"Sphinx extension to add Vim help file generation support","archived":false,"fork":false,"pushed_at":"2023-09-15T14:54:20.000Z","size":207,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-08T13:51:14.305Z","etag":null,"topics":["documentation-tool","sphinx-extension","vim","vim-help"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-contrib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-09-08T14:27:05.000Z","updated_at":"2023-09-14T09:15:22.000Z","dependencies_parsed_at":"2023-09-15T00:05:38.848Z","dependency_job_id":"da6163a1-f09d-4f4f-8883-01ae986f1907","html_url":"https://github.com/sphinx-contrib/vimbuilder","commit_stats":null,"previous_names":["girishji/vimbuilder","sphinx-contrib/vimbuilder"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fvimbuilder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fvimbuilder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fvimbuilder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fvimbuilder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/vimbuilder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241356861,"owners_count":19949613,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation-tool","sphinx-extension","vim","vim-help"],"created_at":"2024-11-12T23:05:56.384Z","updated_at":"2026-05-09T20:24:54.435Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fvimbuilder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Fvimbuilder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fvimbuilder/lists"}