nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-30 18:53:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #102807 - aDotInTheVoid:rdj-rustup-docs, r=jyn514

Browse Source 
Document `rust-docs-json` component

Follow up to #102241

r? ````@jyn514````
This commit is contained in:
Michael Howell 2022-10-08 18:15:01 -07:00 committed by GitHub
commit 8c4191abca
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/doc/rustdoc/src/unstable-features.md
View File

@ -494,6 +494,16 @@ Note that the third item is the crate root, which in this case is undocumented.
[JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/). `--output-format html` has no effect,
and is also accepted on stable toolchains.
JSON Output for toolchain crates (`std`, `alloc`, `core`, `test`, and `proc_macro`)
is available via the `rust-docs-json` rustup component.
```shell
rustup component add --toolchain nightly rust-docs-json
```
Then the json files will be present in the `share/doc/rust/json/` directory
of the rustup toolchain directory.
It can also be used with `--show-coverage`. Take a look at its
[documentation](#--show-coverage-calculate-the-percentage-of-items-with-documentation) for more
information.