mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Migrate rustdoc book to MdBook2

Browse Source
This commit is contained in:
Mateusz Mikuła 2019-05-30 14:22:33 +02:00 committed by Mateusz Mikuła
parent 3ffab36462
commit 5f929be162
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/bootstrap/doc.rs
View File

@ -66,7 +66,7 @@ fn run(self, builder: &Builder<'_>) {
Reference, "src/doc/reference", "reference", RustbookVersion::MdBook1;
RustByExample, "src/doc/rust-by-example", "rust-by-example", RustbookVersion::MdBook1;
RustcBook, "src/doc/rustc", "rustc", RustbookVersion::MdBook1;
RustdocBook, "src/doc/rustdoc", "rustdoc", RustbookVersion::MdBook1;
RustdocBook, "src/doc/rustdoc", "rustdoc", RustbookVersion::MdBook2;
);
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]

8
src/doc/rustdoc/src/command-line-arguments.md
View File

@ -178,7 +178,7 @@ $ rustdoc src/lib.rs --passes strip-priv-imports
An argument of "list" will print a list of possible "rustdoc passes", and other
arguments will be the name of which passes to run in addition to the defaults.
For more details on passes, see [the chapter on them](passes.html).
For more details on passes, see [the chapter on them](passes.md).
See also `--no-defaults`.
@ -194,7 +194,7 @@ By default, `rustdoc` will run several passes over your code. This
removes those defaults, allowing you to use `--passes` to specify
exactly which passes you want.
For more details on passes, see [the chapter on them](passes.html).
For more details on passes, see [the chapter on them](passes.md).
See also `--passes`.
@ -207,7 +207,7 @@ $ rustdoc src/lib.rs --test
```
This flag will run your code examples as tests. For more, see [the chapter
on documentation tests](documentation-tests.html).
on documentation tests](documentation-tests.md).
See also `--test-args`.
@ -220,7 +220,7 @@ $ rustdoc src/lib.rs --test --test-args ignored
```
This flag will pass options to the test runner when running documentation tests.
For more, see [the chapter on documentation tests](documentation-tests.html).
For more, see [the chapter on documentation tests](documentation-tests.md).
See also `--test`.

4
src/doc/rustdoc/src/passes.md
View File

@ -5,8 +5,8 @@ Rustdoc has a concept called "passes". These are transformations that
In addition to the passes below, check out the docs for these flags:
* [`--passes`](command-line-arguments.html#a--passes-add-more-rustdoc-passes)
* [`--no-defaults`](command-line-arguments.html#a--no-defaults-dont-run-default-passes)
* [`--passes`](command-line-arguments.md#--passes-add-more-rustdoc-passes)
* [`--no-defaults`](command-line-arguments.md#--no-defaults-dont-run-default-passes)
## Default passes