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

rustbuild: Add rustbook/standalone doc support #31713

Merged
merged 1 commit into from Mar 1, 2016

Conversation

alexcrichton
Copy link
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
Collaborator

r? @aturon

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

@steveklabnik
Copy link
Member

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
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
Member

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
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
Member

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

@alexcrichton
Copy link
Member Author

r? @brson

@alexcrichton alexcrichton assigned brson and unassigned aturon Feb 25, 2016
@brson
Copy link
Contributor

brson commented Mar 1, 2016

@bors r+

@bors
Copy link
Contributor

bors commented Mar 1, 2016

📌 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
Copy link
Contributor

bors commented Mar 1, 2016

⌛ 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.

None yet

6 participants