Skip to content

Commit 7e64000

Browse files
committed
Document rust-docs-json component
1 parent a688a03 commit 7e64000

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
@@ -465,6 +465,16 @@ Note that the third item is the crate root, which in this case is undocumented.
465465
[JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/). `--output-format html` has no effect,
466466
and is also accepted on stable toolchains.
467467

468+
JSON Output for toolchain crates (`std`, `alloc`, `core`, `test`, and `proc_macro`)
469+
is available via the `rust-docs-json` rustup component.
470+
471+
```shell
472+
rustup component add --toolchain nightly rust-docs-json
473+
```
474+
475+
Then the json files will be present in the `share/doc/rust/json/` directory
476+
of the rustup toolchain directory.
477+
468478
It can also be used with `--show-coverage`. Take a look at its
469479
[documentation](#--show-coverage-calculate-the-percentage-of-items-with-documentation) for more
470480
information.

0 commit comments

Comments
 (0)