Skip to content

Distribute documentation in JSON format via rustup for toolchain components  #101383

Closed
@LukeMathWalker

Description

@LukeMathWalker

Problem

It is currently not possible to access the JSON version of the documentation for crates bundled with the toolchain (core, alloc, std, etc.) via the same mechanism used for "normal" crates:

# This does not succeed
cargo +nightly rustdoc -p std --lib -- -Zunstable-options -wjson

This is due to the fact that those crates are pre-compiled.

Proposed solution

rustup already bundles the HTML version of the documentation for those crates.
We can start bundling the JSON version as a separate rustup component, on the nightly toolchain.

Relevant Zulip discussion.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-rustdoc-jsonArea: Rustdoc JSON backendT-infraRelevant to the infrastructure team, which will review and decide on the PR/issue.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions