Skip to content

Ship the rustdoc book #43863

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
Aug 15, 2017
Merged

Ship the rustdoc book #43863

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
372414c
start building the rustdoc book
steveklabnik Aug 14, 2017
f7b3610
link to the rustdoc book from the main docs
steveklabnik Aug 14, 2017
2c6cf22
Remove plugins chapter
steveklabnik Aug 14, 2017
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
Prev Previous commit
Next Next commit
link to the rustdoc book from the main docs
  • Loading branch information
@steveklabnik
steveklabnik committed Aug 14, 2017
commit f7b3610b252d2624e8db3384092cd224b416bbc9
2 changes: 2 additions & 0 deletions src/doc/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ nicknamed 'The Rust Bookshelf.'
* [The Unstable Book][unstable-book] has documentation for unstable features.
* [The Rustonomicon][nomicon] is your guidebook to the dark arts of unsafe Rust.
* [The Reference][ref] is not a formal spec, but is more detailed and comprehensive than the book.
* [The Rustdoc Book][rustdoc-book] describes our documentation tool, `rustdoc`.

Initially, documentation lands in the Unstable Book, and then, as part of the
stabilization process, is moved into the Book, Nomicon, or Reference.
Expand All @@ -51,4 +52,5 @@ before this policy was put into place. That work is being tracked
[book]: book/index.html
[nomicon]: nomicon/index.html
[unstable-book]: unstable-book/index.html
[rustdoc-book]: rustdoc/index.html