Skip to content

Commit

Permalink
Start the port of the reference to mdBook
Browse files Browse the repository at this point in the history
This only really moves the files, there's a lot more work coming
in the next commits.

Part of rust-lang#39588.
steveklabnik committed Feb 21, 2017

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 8a1ce40 commit c937254
Showing 48 changed files with 4,090 additions and 4 deletions.
4 changes: 0 additions & 4 deletions src/bootstrap/doc.rs
Original file line number Diff line number Diff line change
@@ -115,10 +115,6 @@ pub fn standalone(build: &Build, target: &str) {
.arg("-o").arg(&out)
.arg(&path);

if filename == "reference.md" {
cmd.arg("--html-in-header").arg(&full_toc);
}

if filename == "not_found.md" {
cmd.arg("--markdown-no-toc")
.arg("--markdown-css")
9 changes: 9 additions & 0 deletions src/bootstrap/step.rs
Original file line number Diff line number Diff line change
@@ -568,6 +568,15 @@ pub fn build_rules<'a>(build: &'a Build) -> Rules {
})
.default(build.config.docs)
.run(move |s| doc::rustbook(build, s.target, "nomicon"));
rules.doc("doc-reference", "src/doc/reference")
.dep(move |s| {
s.name("tool-rustbook")
.host(&build.config.build)
.target(&build.config.build)
.stage(0)
})
.default(build.config.docs)
.run(move |s| doc::rustbook(build, s.target, "reference"));
rules.doc("doc-standalone", "src/doc")
.dep(move |s| {
s.name("rustc")
1 change: 1 addition & 0 deletions src/doc/reference/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book
58 changes: 58 additions & 0 deletions src/doc/reference/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# The Rust Reference

[Introduction](introduction.md)

- [Notation](notation.md)
- [Unicode productions](unicode-productions.md)
- [String table productions](string-table-productions.md)

- [Lexical structure](lexical-structure.md)
- [Input format](input-format.md)
- [Identifiers](identifiers.md)
- [Comments](comments.md)
- [Whitespace](whitespace.md)
- [Tokens](tokens.md)
- [Paths](paths.md)

- [Macros](macros.md)
- [Macros By Example](macros-by-example.md)
- [Procedrual Macros](procedural-macros.md)

- [Crates and source files](crates-and-source-files.md)

- [Items and attributes](items-and-attributes.md)
- [Items](items.md)
- [Visibility and Privacy](visibility-and-privacy.md)
- [Attributes](attributes.md)

- [Statements and expressions](statements-and-expressions.md)
- [Statements](statements.md)
- [Expressions](expressions.md)

- [Type system](type-system.md)
- [Types](types.md)
- [Subtyping](subtyping.md)
- [Type coercions](type-coercions.md)

- [Special traits](special-traits.md)
- [The Copy trait](the-copy-trait.md)
- [The Sized trait](the-sized-trait.md)
- [The Drop trait](the-drop-trait.md)
- [The Deref trait](the-deref-trait.md)
- [The Send trait](the-send-trait.md)
- [The Sync trait](the-sync-trait.md)

- [Memory model](memory-model.md)
- [Memory allocation and lifetime](memory-allocation-and-lifetime.md)
- [Memory ownership](memory-ownership.md)
- [Variables](variables.md)

- [Linkage](linkage.md)

- [Unsafety](unsafety.md)
- [Unsafe functions](unsafe-functions.md)
- [Unsafe blocks](unsafe-blocks.md)
- [Behavior considered undefined](behavior-considered-undefined.md)
- [Behavior not considered unsafe](behavior-not-considered-unsafe.md)

[Appendix: Influences](influences.md)
Loading

0 comments on commit c937254

Please sign in to comment.