Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

include librustdoc in the distributed compiler docs #50004

Closed
QuietMisdreavus opened this issue Apr 16, 2018 · 0 comments
Closed

include librustdoc in the distributed compiler docs #50004

QuietMisdreavus opened this issue Apr 16, 2018 · 0 comments
Labels
T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Comments

@QuietMisdreavus
Copy link
Member

#49193 created a bootstrap dist task to create docs for the rustc crates, but this does not include the rustdoc crate.

From a discussion on IRC just now:

<davidtwco> misdreavus, SimonSapin: The rustc doc step runs cargo doc with explicit args for the crates to include. It has a blacklist ignoring some root level crates and then does a DFS on cargo metadata to get the children of that.
<davidtwco> So if librustdoc is not a child of the top most rustc crate. It won't be included.
<davidtwco> You can add a new doc step that runs in the librustdoc folder (more or less the same code as the rustc step) and output it to the same compiler docs folder. Then it'll get picked up by the dist step.
@Mark-Simulacrum Mark-Simulacrum added the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label May 27, 2018
bors added a commit that referenced this issue May 28, 2018
Added rustdoc documentation to compiler docs.

Fixes #50004.

r? @alexcrichton
(since you reviewed the last PR about compiler docs)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

No branches or pull requests

2 participants