@@ -274,11 +274,11 @@ This section has moved to ["Using External Repositories"](./external-repos.md).
274
274
275
275
Documentation improvements are very welcome. The source of ` doc.rust-lang.org `
276
276
is located in [ ` src/doc ` ] in the tree, and standard API documentation is generated
277
- from the source code itself (e.g. [ ` lib.rs ` ] ). Documentation pull requests function
278
- in the same way as other pull requests.
277
+ from the source code itself (e.g. [ ` library/std/src/ lib.rs` ] [ std-root ] ). Documentation pull requests
278
+ function in the same way as other pull requests.
279
279
280
280
[ `src/doc` ] : https://github.com/rust-lang/rust/tree/master/src/doc
281
- [ `lib.rs ` ] : https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs#L1
281
+ [ `std-root ` ] : https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs#L1
282
282
283
283
To find documentation-related issues, sort by the [ A-docs label] [ adocs ] .
284
284
@@ -288,14 +288,11 @@ You can find documentation style guidelines in [RFC 1574][rfc1574].
288
288
289
289
[ rfc1574 ] : https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
290
290
291
- In many cases, you don't need a full ` ./x.py doc --stage 2 ` , which will build
292
- the entire stage 2 compiler and compile the various books published on
293
- [ doc.rust-lang.org] [ docs ] . When updating documentation for the standard library,
294
- first try ` ./x.py doc library ` . If that fails, or if you need to
295
- see the output from the latest version of ` rustdoc ` , add ` --stage 1 ` .
296
- Results should appear in ` build/host/doc ` .
297
-
298
- [ docs ] : https://doc.rust-lang.org
291
+ To build the standard library documentation, use ` x doc --stage 0 library --open ` .
292
+ To build the documentation for a book (e.g. the unstable book), use ` x doc src/doc/unstable-book. `
293
+ Results should appear in ` build/host/doc ` , as well as automatically open in your default browser.
294
+ See [ Building Documentation] ( ./building/compiler-documenting.md#building-documentation ) for more
295
+ information.
299
296
300
297
You can also use ` rustdoc ` directly to check small fixes. For example,
301
298
` rustdoc src/doc/reference.md ` will render reference to ` doc/reference.html ` .
0 commit comments