Skip to content

Commit be2cfac

Browse files
committed
docs: Add instructions on how to locally view rustdocs
For cargo-based projects I usually run `cargo doc --open` but I didn't see an equivalent option with the makefile. Thought it would be nice to document a manual option. A new makefile target feels like too much for something so simple. Signed-off-by: Daniel Xu <[email protected]>
1 parent b9421d4 commit be2cfac

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

Documentation/rust/docs.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ target with the same invocation used for compilation, e.g.::
3535

3636
make LLVM=1 rustdoc
3737

38+
To read the docs locally in your web browser, run e.g.::
39+
40+
xdg-open rust/doc/kernel/index.html
3841

3942
Writing the docs
4043
----------------

0 commit comments

Comments
 (0)