Skip to content

rustbuild: Add rustbook/standalone doc support#31713

Merged
bors merged 1 commit into
rust-lang:masterfrom
alexcrichton:rustbuild-docs
Mar 1, 2016
Merged

rustbuild: Add rustbook/standalone doc support#31713
bors merged 1 commit into
rust-lang:masterfrom
alexcrichton:rustbuild-docs

Conversation

@alexcrichton

Copy link
Copy Markdown
Member

This commit implements documentation generation of the nomicon, the book, the
style guide, and the standalone docs. New steps were added for each one as well
as appropriate makefile targets for each one as well.

This commit implements documentation generation of the nomicon, the book, the
style guide, and the standalone docs. New steps were added for each one as well
as appropriate makefile targets for each one as well.
@rust-highfive

Copy link
Copy Markdown
Contributor

r? @aturon

(rust_highfive has picked a reviewer for you, use r? to override)

@steveklabnik

Copy link
Copy Markdown
Contributor

Would you like me to explore an alternate to this PR which uses mdbook instead? This is something that I've wanted to do for a long time anyway, and this new build system was what would have enabled it; maybe doing it from the start would be nice.

@alexcrichton

Copy link
Copy Markdown
Member Author

It probably wouldn't really be an alternate PR but rather one to just layer on top of this. It'd just involve changing this line, perhaps this source file, and then tweaking how the tool is actually invoked (just arguments and such).

Other than that, everything here will still be needed in terms of dependency tracking, freshness tracking, etc.

@steveklabnik

Copy link
Copy Markdown
Contributor

Sorry, yes, "Alternate PR" was more like "I'll send a PR to this PR swapping out the bits that were specific to rustbook."

@alexcrichton

Copy link
Copy Markdown
Member Author

Perhaps, we probably should do that incrementally, though. I haven't worked 100% through the flow of incorporating crates.io dependencies just yet beyond build dependencies, and I'd just want to be a little careful in doing so.

@steveklabnik

Copy link
Copy Markdown
Contributor

I figured that might be it, which is why I asked. Sounds good to me, we can wait for it.

@alexcrichton

Copy link
Copy Markdown
Member Author

r? @brson

@alexcrichton alexcrichton assigned brson and unassigned aturon Feb 25, 2016
@brson

brson commented Mar 1, 2016

Copy link
Copy Markdown
Contributor

@bors r+

@bors

bors commented Mar 1, 2016

Copy link
Copy Markdown
Collaborator

📌 Commit 848e785 has been approved by brson

bors added a commit that referenced this pull request Mar 1, 2016
This commit implements documentation generation of the nomicon, the book, the
style guide, and the standalone docs. New steps were added for each one as well
as appropriate makefile targets for each one as well.
@bors

bors commented Mar 1, 2016

Copy link
Copy Markdown
Collaborator

⌛ Testing commit 848e785 with merge a93bb13...

@bors bors merged commit 848e785 into rust-lang:master Mar 1, 2016
@alexcrichton alexcrichton deleted the rustbuild-docs branch March 2, 2016 06:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants