Skip to content

Commit

Permalink
Auto merge of #13284 - charmitro:output-format-doc-entry, r=weihanglo
Browse files Browse the repository at this point in the history
 Add documentation entry for unstable `--output-format` flag

This is a follow-up to #12252 adding a documentation entry for the newly supported unstable flag `--output-format`.
  • Loading branch information
bors committed Jan 11, 2024
2 parents 2697837 + 40aa8b1 commit 54fd66a
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/doc/src/reference/unstable.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ For the latest nightly, see the [nightly version] of this page.
* rustdoc
* [rustdoc-map](#rustdoc-map) --- Provides mappings for documentation to link to external sites like [docs.rs](https://docs.rs/).
* [scrape-examples](#scrape-examples) --- Shows examples within documentation.
* [output-format](#output-format-for-rustdoc) --- Allows documentation to also be emitted in the experimental [JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/).
* `Cargo.toml` extensions
* [Profile `rustflags` option](#profile-rustflags-option) --- Passed directly to rustc.
* [codegen-backend](#codegen-backend) --- Select the codegen backend used by rustc.
Expand Down Expand Up @@ -1079,6 +1080,17 @@ If you want examples to be scraped from example targets, then you must not satis
For example, you can set `doc-scrape-examples` to true for one example target, and that signals to Cargo that
you are ok with dev-deps being build for `cargo doc`.

## output-format for rustdoc

* Tracking Issue: [#13283](https://github.com/rust-lang/cargo/issues/13283)

This flag determines the output format of `cargo rustdoc`, accepting `html` or `json`, providing tools with a way to lean on [rustdoc's experimental JSON format](https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc_json_types/).

You can use the flag like this:

```
cargo rustdoc -Z unstable-options --output-format json
```

## check-cfg

Expand Down

0 comments on commit 54fd66a

Please sign in to comment.