Skip to content

doc: build the docs for librustpkg #11488

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 12, 2014
Merged

doc: build the docs for librustpkg #11488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
110e5dd
doc: build the docs for librustpkg
lilyball Jan 12, 2014
de6f213
Restore missing line breaks in doc/index.html
lilyball Jan 12, 2014
d76ce5f
Add librustuv to doc/index.md
lilyball Jan 12, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ src/.DS_Store
/doc/rustc
/doc/syntax
/doc/rustuv
/doc/rustpkg
/nd/
/llvm/
version.md
Expand Down
41 changes: 22 additions & 19 deletions doc/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,33 @@
.header-section-number { display: none; }
</style>

[The Rust tutorial](tutorial.html) ([PDF](tutorial.pdf))
[The Rust reference manual](rust.html) ([PDF](rust.pdf))
[The Rust tutorial](tutorial.html) ([PDF](tutorial.pdf))
[The Rust reference manual](rust.html) ([PDF](rust.pdf))

# Guides

[Pointers](guide-pointers.html)
[References and Lifetimes](guide-lifetimes.html)
[Containers and Iterators](guide-container.html)
[Tasks and Communication](guide-tasks.html)
[Foreign Function Interface](guide-ffi.html)
[Macros](guide-macros.html)
[Packaging](guide-rustpkg.html)
[Testing](guide-testing.html)
[Pointers](guide-pointers.html)
[References and Lifetimes](guide-lifetimes.html)
[Containers and Iterators](guide-container.html)
[Tasks and Communication](guide-tasks.html)
[Foreign Function Interface](guide-ffi.html)
[Macros](guide-macros.html)
[Packaging](guide-rustpkg.html)
[Testing](guide-testing.html)
[Conditions](guide-conditions.html)

# Libraries

[The standard library, `libstd`](std/index.html)
[The standard library, `libstd`](std/index.html)
[The extra library, `libextra`](extra/index.html)

[The M:N runtime library, `libgreen`](green/index.html)
[The M:N runtime library, `libgreen`](green/index.html)
[The 1:1 runtime library, `libnative`](native/index.html)

[The Rust parser, `libsyntax`](syntax/index.html)
[The Rust libuv library, `librustuv`](rustuv/index.html)
[The Rust packaging library, `librustpkg`](rustpkg/index.html)

[The Rust parser, `libsyntax`](syntax/index.html)
[The Rust compiler, `librustc`](rustc/index.html)

# Tooling
Expand All @@ -38,14 +41,14 @@

# FAQs

[Language FAQ](complement-lang-faq.html)
[Project FAQ](complement-project-faq.html)
[Usage FAQ](complement-usage-faq.html)
[Code cheatsheet](complement-cheatsheet.html) - "How do I do X?"
[Language FAQ](complement-lang-faq.html)
[Project FAQ](complement-project-faq.html)
[Usage FAQ](complement-usage-faq.html)
[Code cheatsheet](complement-cheatsheet.html) - "How do I do X?"
[How to submit a bug report](complement-bugreport.html)

# External resources

The Rust [IRC channel](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) - `#rust` on irc.mozilla.org
The Rust community on [Reddit](http://reddit.com/r/rust)
The Rust [IRC channel](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) - `#rust` on irc.mozilla.org
The Rust community on [Reddit](http://reddit.com/r/rust)
The Rust [wiki](http://github.com/mozilla/rust/wiki)
4 changes: 3 additions & 1 deletion mk/docs.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,8 @@ RUSTDOC = $(HBIN2_H_$(CFG_BUILD))/rustdoc$(X_$(CFG_BUILD))
#
# Passes --cfg stage2 to rustdoc because it uses the stage2 librustc.
define libdoc
doc/$(1)/index.html: $$(RUSTDOC) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3))
doc/$(1)/index.html: $$(RUSTDOC) $$(TLIB2_T_$(3)_H_$(3))/$(CFG_STDLIB_$(3)) \
$(foreach name,$(4),$$(TLIB2_T_$(3)_H_$(3))/$$(CFG_$(name)_$(3)))
@$$(call E, rustdoc: $$@)
$(Q)$(RUSTDOC) --cfg stage2 $(2)

Expand All @@ -309,6 +310,7 @@ $(eval $(call libdoc,extra,$(EXTRALIB_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,native,$(LIBNATIVE_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,green,$(LIBGREEN_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,rustuv,$(LIBRUSTUV_CRATE),$(CFG_BUILD)))
$(eval $(call libdoc,rustpkg,$(RUSTPKG_LIB),$(CFG_BUILD),EXTRALIB LIBRUSTC))

$(eval $(call compiledoc,rustc,$(COMPILER_CRATE),$(CFG_BUILD)))
$(eval $(call compiledoc,syntax,$(LIBSYNTAX_CRATE),$(CFG_BUILD)))
Expand Down