This repository was archived by the owner on May 28, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Original file line number Diff line number Diff line change @@ -394,9 +394,13 @@ You can find documentation style guidelines in [RFC 1574][rfc1574].
394394[ rfc1574 ] : https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
395395
396396In many cases, you don't need a full ` ./x.py doc ` , which will build the entire
397- stage 2 compiler. When updating documentation for the standard library, first
398- try ` ./x.py doc --stage 0 src/libstd ` . Results will should appear in
399- ` build/$TARGET/crate-docs ` .
397+ stage 2 compiler and compile the various books published on
398+ [ doc.rust-lang.org] . When updating documentation for the standard library,
399+ first try ` ./x.py doc --stage 0 src/libstd ` . If that fails, or if you need to
400+ see the output from the latest version of ` rustdoc ` , use ` --stage 1 ` instead of
401+ ` --stage 0 ` . Results should appear in ` build/$TARGET/crate-docs ` .
402+
403+ [ doc.rust-lang.org ] : htts://doc.rust-lang.org
400404
401405You can also use ` rustdoc ` directly to check small fixes. For example,
402406` rustdoc src/doc/reference.md ` will render reference to ` doc/reference.html ` .
You can’t perform that action at this time.
0 commit comments