Skip to content

Commit 8c4191a

Browse files
authored
Rollup merge of #102807 - aDotInTheVoid:rdj-rustup-docs, r=jyn514
Document `rust-docs-json` component Follow up to #102241 r? ````@jyn514````
2 parents 21c6a0e + 7e64000 commit 8c4191a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/doc/rustdoc/src/unstable-features.md

+10
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,16 @@ Note that the third item is the crate root, which in this case is undocumented.
494494
[JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/). `--output-format html` has no effect,
495495
and is also accepted on stable toolchains.
496496

497+
JSON Output for toolchain crates (`std`, `alloc`, `core`, `test`, and `proc_macro`)
498+
is available via the `rust-docs-json` rustup component.
499+
500+
```shell
501+
rustup component add --toolchain nightly rust-docs-json
502+
```
503+
504+
Then the json files will be present in the `share/doc/rust/json/` directory
505+
of the rustup toolchain directory.
506+
497507
It can also be used with `--show-coverage`. Take a look at its
498508
[documentation](#--show-coverage-calculate-the-percentage-of-items-with-documentation) for more
499509
information.

0 commit comments

Comments
 (0)