Skip to content
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.

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

Ship the rustdoc book #43863

Merged
merged 3 commits into from
Aug 15, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/bootstrap/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ impl<'a> Builder<'a> {
Kind::Bench => describe!(check::Crate, check::CrateLibrustc),
Kind::Doc => describe!(doc::UnstableBook, doc::UnstableBookGen, doc::TheBook,
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,
dist::Std, dist::Analysis, dist::Src, dist::PlainSourceTarball, dist::Cargo,
dist::Rls, dist::Extended, dist::HashSign),
Expand Down
1 change: 1 addition & 0 deletions src/bootstrap/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ macro_rules! book {
book!(
Nomicon, "src/doc/book", "nomicon";
Reference, "src/doc/reference", "reference";
Rustdoc, "src/doc/rustdoc", "rustdoc";
);

#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
Expand Down
2 changes: 2 additions & 0 deletions src/doc/index.md
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

3 changes: 1 addition & 2 deletions src/doc/rustdoc/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@
- [Command-line arguments](command-line-arguments.md)
- [In-source directives](in-source-directives.md)
- [Documentation tests](documentation-tests.md)
- [Plugins](plugins.md)
- [Passes](passes.md)
- [Passes](passes.md)
28 changes: 1 addition & 27 deletions src/doc/rustdoc/src/command-line-arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
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

Using this flag looks like this:
Expand All @@ -171,18 +157,6 @@ For more details on passes, see [the chapter on them](passes.html).

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

Using this flag looks like this:
Expand Down Expand Up @@ -345,4 +319,4 @@ $ rustdoc src/lib.rs --sysroot /path/to/sysroot
```

Similar to `rustc --sysroot`, this lets you change the sysroot `rustdoc` uses
when compiling your code.
when compiling your code.
3 changes: 0 additions & 3 deletions src/doc/rustdoc/src/plugins.md

This file was deleted.