Skip to content

Commit c93f25f

Browse files
authored
Merge pull request #385 from JohnTitor/mention-rustdoc
Restore `rustdoc` section with the correct instruction
2 parents cb9b4a3 + 555eefb commit c93f25f

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

Documentation/rust/quick-start.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,18 @@ the component manually::
125125
The standalone installers also come with ``clippy``.
126126

127127

128+
rustdoc
129+
*******
130+
131+
If you install the ``rustdoc`` tool, then you will be able to generate pretty
132+
HTML documentation for Rust code, including for the libraries (crates) inside
133+
``rust/`` that are used by the rest of the kernel (for details, please see
134+
:ref:`Documentation/rust/docs.rst <rust_docs>`).
135+
136+
If you are using ``rustup``, all the profiles already install the tool,
137+
so you should be good to go. The standalone installers also come with ``rustdoc``.
138+
139+
128140
rust-analyzer
129141
*************
130142

0 commit comments

Comments
 (0)