mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #123417 - harryhanYuhao:master, r=GuillaumeGomez

Browse Source 
Add Description for cargo in rustdoc documentation

As most people use cargo now, I prioritised the description for cargo in rustdoc documentation.

I also added how to open the generated doc with cargo.

Btw, may I ask how to use `./x tidy`? It says `warning: `tidy` is not installed;`
This commit is contained in:
Jacob Pratt 2024-04-04 21:16:56 -04:00 committed by GitHub
commit 50603cbb6d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/doc/rustdoc/src/what-is-rustdoc.md
View File

@ -34,6 +34,9 @@ the main page is located in `doc/lib/index.html`. If you open that up in
a web browser, you will see a page with a search bar, and "Crate lib" at the a web browser, you will see a page with a search bar, and "Crate lib" at the
top, with no contents. top, with no contents.
You can also use `cargo doc` to generate documentation for the whole project.
See [Using rustdoc with Cargo](#using-rustdoc-with-cargo).
## Configuring rustdoc ## Configuring rustdoc
There are two problems with this: first, why does it There are two problems with this: first, why does it
@ -79,7 +82,13 @@ docs. Instead of the `rustdoc` command, we could have done this:
$ cargo doc $ cargo doc
``` ```
Internally, this calls out to `rustdoc` like this: If you want `cargo` to automatically open the generated documentation, you can use:
```bash
$ cargo doc --open
```
Internally, `cargo doc` calls out to `rustdoc` like this:
```bash ```bash
$ rustdoc --crate-name docs src/lib.rs -o <path>/docs/target/doc -L $ rustdoc --crate-name docs src/lib.rs -o <path>/docs/target/doc -L