https://github.com/octaltree/rustdoc-index
A fast listing tool for rustdoc
https://github.com/octaltree/rustdoc-index
denite-source rust
Last synced: 2 months ago
JSON representation
A fast listing tool for rustdoc
- Host: GitHub
- URL: https://github.com/octaltree/rustdoc-index
- Owner: octaltree
- Created: 2021-03-30T15:14:05.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-09-26T10:06:27.000Z (almost 2 years ago)
- Last Synced: 2025-04-13T15:04:45.115Z (2 months ago)
- Topics: denite-source, rust
- Language: Rust
- Homepage:
- Size: 149 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rustdoc-index
[](https://crates.io/crates/rustdoc-index) [](https://docs.rs/rustdoc-index/) 
A tool to quickly find the relevant item from rustdoc.
## Installation
$ cargo install rustdoc-index
$ rustup component add rust-docs
It requires Rust 1.53 that is now avaible on stable.
## Usage
```sh
$ cargo listdoc
std::prelude mod
std::prelude::v1 mod
std::prelude::rust_2015 mod
std::prelude::rust_2018 mod
std::prelude::rust_2021 mod
std::f32 mod
std::f32::consts mod
std::f32::consts::PI constant
std::f32::consts::TAU constant
std::f32::consts::FRAC_PI_2 constant
...
```
```sh
$ cargo listdoc location "std::f32::consts::PI constant"
file:///home/octaltree/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/share/doc/rust/html/std/f32/consts/constant.PI.html
```
### With [junegunn/fzf](https://github.com/junegunn/fzf)
```sh
cargo listdoc | fzf --bind 'ctrl-i:execute(cargo listdoc location {}| xargs firefox)'
```
## Vim integration
[denite](https://github.com/Shougo/denite.nvim) source is available.
### Installation
This is how to install using [dein](https://github.com/Shougo/dein.vim).
```toml
[[plugins]]
repo = 'octaltree/rustdoc-index'
build = 'make denite'
```
### Usage
```vim
:Denite rustdoc-index
```
This is highly inspired by [rhysd/rust-doc.vim](https://github.com/rhysd/rust-doc.vim). If you need the unite interface, please use that one.