about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2013-09-23 22:26:06 -0700
committerbors <bors@rust-lang.org>2013-09-23 22:26:06 -0700
commitdf8231e134fbc3c5d121d48d12fa991949295711 (patch)
tree0bce6c1da42c8a416bd4c2694f6396575c9ae238
parentc1b187d41b2cb16a409259f1530bc8fcc705364f (diff)
parent06b11ba1723e920d544e917bbe27e7eb7b03a610 (diff)
downloadrust-df8231e134fbc3c5d121d48d12fa991949295711.tar.gz
rust-df8231e134fbc3c5d121d48d12fa991949295711.zip
auto merge of #9439 : steveklabnik/rust/build_rustpkg_tutorial, r=brson
Three things in this commit:

1. Actually build the rustpkg tutorial. I didn't know I needed this when
   I first wrote it.
2. Link to it rather than the manual from the
   tutorial.
3. Update the headers: most of them were one level too deeply
   nested.
-rw-r--r--doc/tutorial-rustpkg.md14
-rw-r--r--doc/tutorial.md2
-rw-r--r--mk/docs.mk10
3 files changed, 18 insertions, 8 deletions
diff --git a/doc/tutorial-rustpkg.md b/doc/tutorial-rustpkg.md
index 43d83093eea..f1cf78fc630 100644
--- a/doc/tutorial-rustpkg.md
+++ b/doc/tutorial-rustpkg.md
@@ -7,7 +7,7 @@ package up your Rust code and share it with other people. This tutorial will
 get you started on all of the concepts and commands you need to give the gift
 of Rust code to someone else.
 
-## Installing External Packages
+# Installing External Packages
 
 First, let's try to use an external package somehow. I've made a sample package
 called `hello` to demonstrate how to do so.  Here's how `hello` is used:
@@ -68,7 +68,7 @@ Hello, world.
 
 Simple! That's all it takes.
 
-## Workspaces
+# Workspaces
 
 Before we can talk about how to make packages of your own, you have to
 understand the big concept with `rustpkg`: workspaces. A 'workspace' is simply
@@ -88,14 +88,14 @@ There are also default file names you'll want to follow as well:
 * `main.rs`: A file that's going to become an executable.
 * `lib.rs`: A file that's going to become a library.
 
-## Building your own Package
+# Building your own Package
 
 Now that you've got workspaces down, let's build your own copy of `hello`. Go
 to wherever you keep your personal projects, and let's make all of the
 directories we'll need. I'll refer to this personal project directory as
 `~/src` for the rest of this tutorial.
 
-### Creating our workspace
+## Creating our workspace
 
 ~~~ {.notrust}
 $ cd ~/src
@@ -150,7 +150,7 @@ pub fn world() {
 
 Put this into `src/hello/lib.rs`. Let's talk about each of these attributes:
 
-### Crate attributes for packages
+## Crate attributes for packages
 
 `license` is equally simple: the license we want this code to have. I chose MIT
 here, but you should pick whatever license makes the most sense for you.
@@ -158,7 +158,7 @@ here, but you should pick whatever license makes the most sense for you.
 `desc` is a description of the package and what it does. This should just be a
 sentence or two.
 
-### Building your package
+## Building your package
 
 Building your package is simple:
 
@@ -206,7 +206,7 @@ note: Installed package github.com/YOUR_USERNAME/hello-0.1 to /home/yourusername
 
 That's it!
 
-## More resources
+# More resources
 
 There's a lot more going on with `rustpkg`, this is just to get you started.
 Check out [the rustpkg manual](rustpkg.html) for the full details on how to
diff --git a/doc/tutorial.md b/doc/tutorial.md
index a8d384226a3..2f9a84d984f 100644
--- a/doc/tutorial.md
+++ b/doc/tutorial.md
@@ -2995,7 +2995,7 @@ There is further documentation on the [wiki], however those tend to be even more
 [tasks]: tutorial-tasks.html
 [macros]: tutorial-macros.html
 [ffi]: tutorial-ffi.html
-[rustpkg]: rustpkg.html
+[rustpkg]: tutorial-rustpkg.html
 
 [wiki]: https://github.com/mozilla/rust/wiki/Docs
 
diff --git a/mk/docs.mk b/mk/docs.mk
index b89bf3483fc..e38590188b3 100644
--- a/mk/docs.mk
+++ b/mk/docs.mk
@@ -160,6 +160,16 @@ doc/tutorial-conditions.html: tutorial-conditions.md doc/version_info.html doc/r
            --include-before-body=doc/version_info.html \
            --output=$@
 
+DOCS += doc/tutorial-rustpkg.html
+doc/tutorial-rustpkg.html: tutorial-rustpkg.md doc/version_info.html doc/rust.css
+	@$(call E, pandoc: $@)
+	$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
+          $(CFG_PANDOC) --standalone --toc \
+           --section-divs --number-sections \
+           --from=markdown --to=html --css=rust.css \
+           --include-before-body=doc/version_info.html \
+           --output=$@
+
   ifeq ($(CFG_PDFLATEX),)
     $(info cfg: no pdflatex found, omitting doc/rust.pdf)
   else