Skip to content
This repository was archived by the owner on Jan 3, 2024. It is now read-only.

Commit 71d2cf6

Browse files
simrat39github-actions[bot]
simrat39
authored and
github-actions[bot]
committed
Auto generate docs
1 parent 6b069c5 commit 71d2cf6

File tree

1 file changed

+49
-61
lines changed

1 file changed

+49
-61
lines changed

‎doc/rust-tools.txt‎

Lines changed: 49 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
1-
*rust-tools.txt* For NVIM v0.8.0 Last change: 2023 February 05
1+
*rust-tools.txt* For NVIM v0.8.0 Last change: 2023 February 20
22

33
==============================================================================
44
Table of Contents *rust-tools-table-of-contents*
55

66
1. rust-tools.nvim |rust-tools-rust-tools.nvim|
7-
- Quick Links |rust-tools-quick-links|
8-
- Prerequisites |rust-tools-prerequisites|
9-
- Installation |rust-tools-installation|
10-
- Setup |rust-tools-setup|
11-
- Usage |rust-tools-usage|
12-
- Configuration |rust-tools-configuration|
13-
- Related Projects |rust-tools-related-projects|
14-
- Inspiration |rust-tools-inspiration|
7+
- Quick Links |rust-tools-rust-tools.nvim-quick-links|
8+
- Prerequisites |rust-tools-rust-tools.nvim-prerequisites|
9+
- Installation |rust-tools-rust-tools.nvim-installation|
10+
- Setup |rust-tools-rust-tools.nvim-setup|
11+
- Usage |rust-tools-rust-tools.nvim-usage|
12+
- Configuration |rust-tools-rust-tools.nvim-configuration|
13+
- Related Projects |rust-tools-rust-tools.nvim-related-projects|
14+
- Inspiration |rust-tools-rust-tools.nvim-inspiration|
1515

1616
==============================================================================
1717
1. rust-tools.nvim *rust-tools-rust-tools.nvim*
1818

1919
A plugin to improve your rust experience in neovim.
2020

21-
QUICK LINKS *rust-tools-quick-links*
21+
22+
QUICK LINKS *rust-tools-rust-tools.nvim-quick-links*
2223

2324

2425
- Wiki <https://github.com/simrat39/rust-tools.nvim/wiki>
@@ -29,7 +30,7 @@ QUICK LINKS *rust-tools-quick-links*
2930
- |rust-tools-usage|
3031

3132

32-
PREREQUISITES *rust-tools-prerequisites*
33+
PREREQUISITES *rust-tools-rust-tools.nvim-prerequisites*
3334

3435

3536
- `neovim 0.7`
@@ -38,11 +39,11 @@ PREREQUISITES *rust-tools-prerequisites*
3839
- `dot` from `graphviz` (only for crate graph)
3940

4041

41-
INSTALLATION *rust-tools-installation*
42+
INSTALLATION *rust-tools-rust-tools.nvim-installation*
4243

4344
using `packer.nvim`
4445

45-
>
46+
>lua
4647
use 'neovim/nvim-lspconfig'
4748
use 'simrat39/rust-tools.nvim'
4849

@@ -51,22 +52,22 @@ using `packer.nvim`
5152
use 'mfussenegger/nvim-dap'
5253
<
5354

55+
Look at the configuration information below to get started.
5456

55-
Look at the configuration information below to get started. ~
5657

57-
SETUP *rust-tools-setup*
58+
SETUP *rust-tools-rust-tools.nvim-setup*
5859

5960
This plugin automatically sets up nvim-lspconfig for rust_analyzer for you, so
6061
don’t do that manually, as it causes conflicts.
6162

62-
Put this in your init.lua or any lua file that is sourced.<br>
63+
Put this in your init.lua or any lua file that is sourced.
6364

6465
For most people, the defaults are fine, but for advanced configuration, see
6566
|rust-tools-configuration|.
6667

6768
Example config:
6869

69-
>
70+
>lua
7071
local rt = require("rust-tools")
7172

7273
rt.setup({
@@ -82,21 +83,14 @@ Example config:
8283
<
8384

8485

85-
USAGE *rust-tools-usage*
86+
USAGE *rust-tools-rust-tools.nvim-usage*
8687

8788
Debugging ~
8889

89-
<div class="figure">
90-
<img src="https://github.com/simrat39/rust-tools-demos/raw/master/rust-tools-debug.gif" title="fig:"/>
91-
<p class="caption">debugging</p>
92-
</div>
93-
9490
Inlay Hints ~
9591

96-
<img
97-
src='https://github.com/simrat39/rust-tools-demos/raw/master/inlay_hints.png'
98-
title=''/> ```lua – Commands: – RustEnableInlayHints –
99-
RustDisableInlayHints – RustSetInlayHints – RustUnsetInlayHints
92+
```lua – Commands: – RustEnableInlayHints – RustDisableInlayHints –
93+
RustSetInlayHints – RustUnsetInlayHints
10094

10195
– Set inlay hints for the current buffer
10296
require('rust-tools').inlay_hints.set() – Unset inlay hints for the current
@@ -106,74 +100,55 @@ buffer require('rust-tools').inlay_hints.unset()
106100
require('rust-tools').inlay_hints.enable()
107101
– Disable inlay hints auto update and unset them for all buffers
108102
require('rust-tools').inlay_hints.disable()
109-
```
103+
```Runnables ~
110104

111-
Runnables ~
112105

113-
<img src='https://github.com/simrat39/rust-tools-demos/raw/master/runnables.gif' title=''/>
114-
`lua -- Command: -- RustRunnables require('rust-tools').runnables.runnables()`
106+
`lua -- Command: -- RustRunnables require('rust-tools').runnables.runnables()`Expand Macros Recursively ~
115107

116-
Expand Macros Recursively ~
117108

118-
<img src='https://github.com/simrat39/rust-tools-demos/raw/master/expand_macros_recursively.gif' title=''/>
119-
`lua -- Command: -- RustExpandMacro require'rust-tools'.expand_macro.expand_macro()`
109+
`lua -- Command: -- RustExpandMacro require'rust-tools'.expand_macro.expand_macro()`Move Item Up/Down ~
120110

121-
Move Item Up/Down ~
122111

123-
<img src='https://github.com/simrat39/rust-tools-demos/raw/master/move_item.gif' title=''/>
124-
`lua -- Command: -- RustMoveItemUp -- RustMoveItemDown local up = true -- true = move up, false = move down require'rust-tools'.move_item.move_item(up)`
112+
`lua -- Command: -- RustMoveItemUp -- RustMoveItemDown local up = true -- true = move up, false = move down require'rust-tools'.move_item.move_item(up)`Hover Actions ~
125113

126-
Hover Actions ~
127114

128-
<img src='https://github.com/simrat39/rust-tools-demos/raw/master/hover_actions.gif' title=''/>
129115
Note: To activate hover actions, run the command twice (or your hover keymap if you have `hover_with_actions` set to true AND are using `vim.lsp.buf.hover()`). This will move you into the window, then press enter on the selection you want. Alternatively, you can set `auto_focus` to true in your config and you will automatically enter the hover actions window.
130-
`lua -- Command: -- RustHoverActions require'rust-tools'.hover_actions.hover_actions()`
131-
132-
Hover Range ~
116+
`lua -- Command: -- RustHoverActions require'rust-tools'.hover_actions.hover_actions()`Hover Range ~
133117

134118
Note: Requires rust-analyzer version after 2021-08-02. Shows the type in visual mode when hovering.
135-
`lua -- Command: -- RustHoverRange require'rust-tools'.hover_range.hover_range()`
136-
137-
Open Cargo.toml ~
119+
`lua -- Command: -- RustHoverRange require'rust-tools'.hover_range.hover_range()`Open Cargo.toml ~
138120

139-
<img src='https://github.com/simrat39/rust-tools-demos/raw/master/open_cargo_toml.gif' title=''/>
140-
`lua -- Command: -- RustOpenCargo require'rust-tools'.open_cargo_toml.open_cargo_toml()`
141121

142-
Parent Module ~
122+
`lua -- Command: -- RustOpenCargo require'rust-tools'.open_cargo_toml.open_cargo_toml()`Parent Module ~
143123

144-
<img src='https://github.com/simrat39/rust-tools-demos/raw/master/parent_module.gif' title=''/>
145-
`lua -- Command: -- RustParentModule require'rust-tools'.parent_module.parent_module()`
146124

147-
Join Lines ~
125+
`lua -- Command: -- RustParentModule require'rust-tools'.parent_module.parent_module()`Join Lines ~
148126

149-
<img src='https://github.com/simrat39/rust-tools-demos/raw/master/join_lines.gif' title=''/>
150-
`lua -- Command: -- RustJoinLines require'rust-tools'.join_lines.join_lines()`
151127

152-
Structural Search Replace ~
128+
`lua -- Command: -- RustJoinLines require'rust-tools'.join_lines.join_lines()`Structural Search Replace ~
153129

154-
>
130+
>lua
155131
-- Command:
156132
-- RustSSR [query]
157133
require'rust-tools'.ssr.ssr(query)
158134
<
159135

160-
161136
View Crate Graph ~
162137

163-
>
138+
>lua
164139
-- Command:
165140
-- RustViewCrateGraph [backend [output]]
166141
require'rust-tools'.crate_graph.view_crate_graph(backend, output)
167142
<
168143

169144

170-
CONFIGURATION *rust-tools-configuration*
145+
CONFIGURATION *rust-tools-rust-tools.nvim-configuration*
171146

172147
The options shown below are the defaults. You only need to pass the keys to the
173148
setup function that you want to be changed, because the defaults are applied
174149
for keys that are not provided.
175150

176-
>
151+
>lua
177152
local opts = {
178153
tools = { -- rust-tools options
179154

@@ -353,17 +328,30 @@ for keys that are not provided.
353328
<
354329

355330

356-
RELATED PROJECTS *rust-tools-related-projects*
331+
RELATED PROJECTS *rust-tools-rust-tools.nvim-related-projects*
357332

358333

359334
- `Saecki/crates.nvim` <https://github.com/Saecki/crates.nvim>
360335

361336

362-
INSPIRATION *rust-tools-inspiration*
337+
INSPIRATION *rust-tools-rust-tools.nvim-inspiration*
363338

364339
This plugin draws inspiration from `akinsho/flutter-tools.nvim`
365340
<https://github.com/akinsho/flutter-tools.nvim>
366341

342+
==============================================================================
343+
2. Links *rust-tools-links*
344+
345+
1. *debugging*: https://github.com/simrat39/rust-tools-demos/raw/master/rust-tools-debug.gif
346+
2. *inlay hints*: https://github.com/simrat39/rust-tools-demos/raw/master/inlay_hints.png
347+
3. *runnables*: https://github.com/simrat39/rust-tools-demos/raw/master/runnables.gif
348+
4. *expand macros*: https://github.com/simrat39/rust-tools-demos/raw/master/expand_macros_recursively.gif
349+
5. *move items*: https://github.com/simrat39/rust-tools-demos/raw/master/move_item.gif
350+
6. *hover actions*: https://github.com/simrat39/rust-tools-demos/raw/master/hover_actions.gif
351+
7. *open cargo*: https://github.com/simrat39/rust-tools-demos/raw/master/open_cargo_toml.gif
352+
8. *parent module*: https://github.com/simrat39/rust-tools-demos/raw/master/parent_module.gif
353+
9. *join lines*: https://github.com/simrat39/rust-tools-demos/raw/master/join_lines.gif
354+
367355
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
368356

369357
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)