Skip to content

Commit

Permalink
Rollup merge of rust-lang#102807 - aDotInTheVoid:rdj-rustup-docs, r=j…
Browse files Browse the repository at this point in the history
…yn514

Document `rust-docs-json` component

Follow up to rust-lang#102241

r? `@jyn514`
  • Loading branch information
matthiaskrgr authored Oct 8, 2022
2 parents 87e219a + 7e64000 commit 9f7213f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/doc/rustdoc/src/unstable-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 9f7213f

Please sign in to comment.