Skip to content

Commit

Permalink
Auto merge of #39633 - steveklabnik:vendor-mdbook, r=alexcrichton
Browse files Browse the repository at this point in the history
Port books to mdbook

Part of #39588

blocked on #39431

As a first step towards the bookshelf, we ~vendor mdbook in-tree and~ port our books to it. Eventually, both of these books will be moved out-of-tree, but the nightly book will rely on doing the same thing. As such, this intermediate step is useful.

r? @alexcrichton @brson

/cc @azerupi
  • Loading branch information
bors committed Feb 15, 2017
2 parents e8154a0 + cacb3bc commit 025c328
Show file tree
Hide file tree
Showing 151 changed files with 587 additions and 1,199 deletions.
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
*.rs rust
src/etc/installer/gfx/* binary
*.woff binary
src/vendor/* binary
src/vendor/** -text
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,4 @@ version.md
version.ml
version.texi
.cargo
!src/vendor/**
216 changes: 215 additions & 1 deletion src/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions src/bootstrap/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ pub fn rustbook(build: &Build, target: &str, name: &str) {
build.run(build.tool_cmd(&compiler, "rustbook")
.arg("build")
.arg(&src)
.arg("-d")
.arg(out));
}

Expand Down
2 changes: 1 addition & 1 deletion src/doc/book/README.md → src/doc/book/src/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% The Rust Programming Language
# The Rust Programming Language

Welcome! This book will teach you about the [Rust Programming Language][rust].
Rust is a systems programming language focused on three goals: safety, speed,
Expand Down
2 changes: 2 additions & 0 deletions src/doc/book/SUMMARY.md → src/doc/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Summary

[Introduction](README.md)

* [Getting Started](getting-started.md)
* [Tutorial: Guessing Game](guessing-game.md)
* [Syntax and Semantics](syntax-and-semantics.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% Advanced Linking
# Advanced Linking

The common cases of linking with Rust have been covered earlier in this book,
but supporting the range of linking possibilities made available by other
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% Associated Constants
# Associated Constants

With the `associated_consts` feature, you can define constants like this:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% Associated Types
# Associated Types

Associated types are a powerful part of Rust’s type system. They’re related to
the idea of a ‘type family’, in other words, grouping multiple types together. That
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% Attributes
# Attributes

Declarations can be annotated with ‘attributes’ in Rust. They look like this:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% Benchmark tests
# Benchmark tests

Rust supports benchmark tests, which can test the performance of your
code. Let's make our `src/lib.rs` look like this (comments elided):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
% Bibliography
# Bibliography

This is a reading list of material relevant to Rust. It includes prior
research that has - at one time or another - influenced the design of
Expand Down
Loading

0 comments on commit 025c328

Please sign in to comment.