From 372414ce384c3817915beb04cb2d1b0b055783ed Mon Sep 17 00:00:00 2001 From: steveklabnik Date: Mon, 14 Aug 2017 13:56:41 -0400 Subject: [PATCH 1/3] start building the rustdoc book --- src/bootstrap/builder.rs | 2 +- src/bootstrap/doc.rs | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/src/bootstrap/builder.rs b/src/bootstrap/builder.rs index d7f795e405534..a85278de4c630 100644 --- a/src/bootstrap/builder.rs +++ b/src/bootstrap/builder.rs @@ -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), diff --git a/src/bootstrap/doc.rs b/src/bootstrap/doc.rs index 1ee578bb62b19..3cb67c245b9d7 100644 --- a/src/bootstrap/doc.rs +++ b/src/bootstrap/doc.rs @@ -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)] From f7b3610b252d2624e8db3384092cd224b416bbc9 Mon Sep 17 00:00:00 2001 From: steveklabnik Date: Mon, 14 Aug 2017 13:58:21 -0400 Subject: [PATCH 2/3] link to the rustdoc book from the main docs --- src/doc/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/doc/index.md b/src/doc/index.md index fd5b120e81fae..bfd09145baafa 100644 --- a/src/doc/index.md +++ b/src/doc/index.md @@ -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. @@ -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 From 2c6cf22a30bf09eb5183b1326e6c74347df72f77 Mon Sep 17 00:00:00 2001 From: steveklabnik Date: Mon, 14 Aug 2017 17:02:15 -0400 Subject: [PATCH 3/3] Remove plugins chapter we don't want to support plugins --- src/doc/rustdoc/src/SUMMARY.md | 3 +- src/doc/rustdoc/src/command-line-arguments.md | 28 +------------------ src/doc/rustdoc/src/plugins.md | 3 -- 3 files changed, 2 insertions(+), 32 deletions(-) delete mode 100644 src/doc/rustdoc/src/plugins.md diff --git a/src/doc/rustdoc/src/SUMMARY.md b/src/doc/rustdoc/src/SUMMARY.md index cd6883a719c18..73070c23b5c43 100644 --- a/src/doc/rustdoc/src/SUMMARY.md +++ b/src/doc/rustdoc/src/SUMMARY.md @@ -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) \ No newline at end of file +- [Passes](passes.md) diff --git a/src/doc/rustdoc/src/command-line-arguments.md b/src/doc/rustdoc/src/command-line-arguments.md index 36c1b050dd50f..0f0bda65ce379 100644 --- a/src/doc/rustdoc/src/command-line-arguments.md +++ b/src/doc/rustdoc/src/command-line-arguments.md @@ -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: @@ -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: @@ -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. \ No newline at end of file +when compiling your code. diff --git a/src/doc/rustdoc/src/plugins.md b/src/doc/rustdoc/src/plugins.md deleted file mode 100644 index c0d5ed752c6a1..0000000000000 --- a/src/doc/rustdoc/src/plugins.md +++ /dev/null @@ -1,3 +0,0 @@ -# Plugins - -Coming soon! \ No newline at end of file