Auto merge of #43863 - steveklabnik:ship-the-rustdoc-book, r=frewsxcv

Ship the rustdoc book

Fixes #42322, as it's the last step.

Blocked on https://github.com/rust-lang/rust/pull/43790, though they will not conflict.

r? @rust-lang/docs
This commit is contained in:
bors 2017-08-15 07:28:54 +00:00
commit c774c95919
6 changed files with 6 additions and 33 deletions

View File

@ -257,7 +257,7 @@ impl<'a> Builder<'a> {
Kind::Bench => describe!(check::Crate, check::CrateLibrustc), Kind::Bench => describe!(check::Crate, check::CrateLibrustc),
Kind::Doc => describe!(doc::UnstableBook, doc::UnstableBookGen, doc::TheBook, Kind::Doc => describe!(doc::UnstableBook, doc::UnstableBookGen, doc::TheBook,
doc::Standalone, doc::Std, doc::Test, doc::Rustc, doc::ErrorIndex, doc::Nomicon, doc::Standalone, doc::Std, doc::Test, doc::Rustc, doc::ErrorIndex, doc::Nomicon,
doc::Reference), doc::Reference, doc::Rustdoc),
Kind::Dist => describe!(dist::Docs, dist::Mingw, dist::Rustc, dist::DebuggerScripts, Kind::Dist => describe!(dist::Docs, dist::Mingw, dist::Rustc, dist::DebuggerScripts,
dist::Std, dist::Analysis, dist::Src, dist::PlainSourceTarball, dist::Cargo, dist::Std, dist::Analysis, dist::Src, dist::PlainSourceTarball, dist::Cargo,
dist::Rls, dist::Extended, dist::HashSign), dist::Rls, dist::Extended, dist::HashSign),

View File

@ -68,6 +68,7 @@ macro_rules! book {
book!( book!(
Nomicon, "src/doc/book", "nomicon"; Nomicon, "src/doc/book", "nomicon";
Reference, "src/doc/reference", "reference"; Reference, "src/doc/reference", "reference";
Rustdoc, "src/doc/rustdoc", "rustdoc";
); );
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)] #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]

View File

@ -31,6 +31,7 @@ nicknamed 'The Rust Bookshelf.'
* [The Unstable Book][unstable-book] has documentation for unstable features. * [The Unstable Book][unstable-book] has documentation for unstable features.
* [The Rustonomicon][nomicon] is your guidebook to the dark arts of unsafe Rust. * [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 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 Initially, documentation lands in the Unstable Book, and then, as part of the
stabilization process, is moved into the Book, Nomicon, or Reference. stabilization process, is moved into the Book, Nomicon, or Reference.
@ -51,4 +52,5 @@ before this policy was put into place. That work is being tracked
[book]: book/index.html [book]: book/index.html
[nomicon]: nomicon/index.html [nomicon]: nomicon/index.html
[unstable-book]: unstable-book/index.html [unstable-book]: unstable-book/index.html
[rustdoc-book]: rustdoc/index.html

View File

@ -4,5 +4,4 @@
- [Command-line arguments](command-line-arguments.md) - [Command-line arguments](command-line-arguments.md)
- [The `#[doc]` attribute](the-doc-attribute.md) - [The `#[doc]` attribute](the-doc-attribute.md)
- [Documentation tests](documentation-tests.md) - [Documentation tests](documentation-tests.md)
- [Plugins](plugins.md) - [Passes](passes.md)
- [Passes](passes.md)

View File

@ -141,20 +141,6 @@ Similar to `--library-path`, `--extern` is about specifying the location
of a dependency. `--library-path` provides directories to search in, `--extern` of a dependency. `--library-path` provides directories to search in, `--extern`
instead lets you specify exactly which dependency is located where. instead lets you specify exactly which dependency is located where.
## `--plugin-path`: loading plugins
Using this flag looks like this:
```bash
$ rustdoc src/lib.rs --plugin-path=/path/to/plugins
```
Similar to `--library-path`, but for plugins. For more, see
the [chapter on plugins](plugins.html).
See also: `--plugins`.
## `--passes`: add more rustdoc passes ## `--passes`: add more rustdoc passes
Using this flag looks like this: Using this flag looks like this:
@ -171,18 +157,6 @@ For more details on passes, see [the chapter on them](passes.html).
See also `--no-defaults`. See also `--no-defaults`.
## `--plugins`:
Using this flag looks like this:
```bash
$ rustdoc src/lib.rs --plugins foo bar
```
For more, see the [chapter on plugins](plugins.html).
See also: `--plugin-path`.
## `--no-defaults`: don't run default passes ## `--no-defaults`: don't run default passes
Using this flag looks like this: Using this flag looks like this:
@ -345,4 +319,4 @@ $ rustdoc src/lib.rs --sysroot /path/to/sysroot
``` ```
Similar to `rustc --sysroot`, this lets you change the sysroot `rustdoc` uses Similar to `rustc --sysroot`, this lets you change the sysroot `rustdoc` uses
when compiling your code. when compiling your code.

View File

@ -1,3 +0,0 @@
# Plugins
Coming soon!