Skip to content

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

Closed
@LukeMathWalker

Description

@LukeMathWalker
Contributor

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.

Activity

aDotInTheVoid

aDotInTheVoid commented on Sep 3, 2022

@aDotInTheVoid
Member

@rustbot modify labels: +A-rustdoc-json +T-rustdoc +T-infra

added
T-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.
on Sep 3, 2022
added a commit that references this issue on Sep 16, 2022

Rollup merge of rust-lang#101799 - LukeMathWalker:distribute-json-doc…

a00a2d3
added a commit that references this issue on Sep 17, 2022

Rollup merge of rust-lang#101799 - LukeMathWalker:distribute-json-doc…

9a6aad4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

      Participants

      @LukeMathWalker@aDotInTheVoid@rustbot

      Issue actions

        Distribute documentation in JSON format via rustup for toolchain components · Issue #101383 · rust-lang/rust