diff options
| author | Michael Howell <michael@notriddle.com> | 2022-10-08 18:15:01 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-08 18:15:01 -0700 |
| commit | 8c4191abcad619f15e2c4f6342916bc021dec200 (patch) | |
| tree | c1c25ae5dfd42fbac4615588b2669d5a8615e8ba /src/doc/rustdoc | |
| parent | 21c6a0e364d83a86e864c4bc9db4ae7710ac46de (diff) | |
| parent | 7e640009154968b769584dbc39f2a1c3a9ab3f0f (diff) | |
| download | rust-8c4191abcad619f15e2c4f6342916bc021dec200.tar.gz rust-8c4191abcad619f15e2c4f6342916bc021dec200.zip | |
Rollup merge of #102807 - aDotInTheVoid:rdj-rustup-docs, r=jyn514
Document `rust-docs-json` component Follow up to #102241 r? ````@jyn514````
Diffstat (limited to 'src/doc/rustdoc')
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index c6c05e30090..b8b5014ab42 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -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. |