https://github.com/zeioth/vim-rustdoc
Rustdoc integration for vim
https://github.com/zeioth/vim-rustdoc
Last synced: 5 months ago
JSON representation
Rustdoc integration for vim
- Host: GitHub
- URL: https://github.com/zeioth/vim-rustdoc
- Owner: Zeioth
- License: gpl-3.0
- Created: 2023-04-23T23:27:04.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-19T15:24:44.000Z (about 3 years ago)
- Last Synced: 2025-10-14T08:58:12.787Z (9 months ago)
- Language: Vim Script
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# vim-rustdoc
Out of the box, this plugin automatically regenerates your rustdoc
documentation. Currently, this plugin is in highly experimental state.
## Dependencies
None. This tool is shipped with Rust.
## Documentation
Please use <:h rustdoc> on vim to read the [full documentation](https://github.com/Zeioth/vim-rustdoc/blob/main/doc/rustdoc.txt).
## How to use
Copy this in your vimconfig:
```
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
" => vim rustdoc
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
" Enable it for the next languages
let g:rustdoc_include_filetypes = ['rust']
" Enable the keybindings for the languages in g:rustdoc_include_filetypes
augroup rustdoc_mappings
for ft in g:rustdoc_include_filetypes
execute 'autocmd FileType ' . ft . ' nnoremap :RustdocOpen'
"execute 'autocmd FileType ' . ft . ' nnoremap :RustdocRegen'
endfor
augroup END
```
## Most frecuent options users customize
Enable automated doc generation on save (optional)
```
" Enabled by default for the languages defined in g:rustdoc_include_filetypes
let g:rustdoc_auto_regen = 1
```
Change the way the documentation is opened (optional)
```
" rustdoc - Open on browser
let g:rustdoc_browser_cmd = get(g:, 'rustdoc_browser_cmd', 'xdg-open')
let g:rustdoc_browser_file = get(g:, 'rustdoc_browser_file', './docs/index.html')
```
Custom command to generate the rustdoc documentation (optional)
```
let g:rustdoc_cmd = 'rustdoc'
```
Change the way the root of the project is detected (optional)
```
" By default, we detect the root of the project where the first .git file is found
let g:rustdoc_project_root = ['.git', '.hg', '.svn', '.bzr', '_darcs', '_FOSSIL_', '.fslckout']
```
## Final notes
Please have in mind that you are responsable for adding your rustdoc directory to the .gitignore if you don't want it to be pushed by accident.
It is also possible to disable this plugin for a single project. For that, create .norustdoc file in the project root directory.
## Credits
This project started as a hack of [vim-doxygen](https://github.com/Zeioth/vim-doxygen), which started as a hack of [vim-guttentags](https://github.com/ludovicchabant/vim-gutentags). We use its boiler plate functions to manage directories in vimscript with good compatibility across operative systems. So please support its author too if you can!