3 You might want to build documentation of the various components
4 available like the standard library. There’s two ways to go about this.
5 You can run rustdoc directly on the file to make sure the HTML is
6 correct, which is fast. Alternatively, you can build the documentation
7 as part of the build process through x.py. Both are viable methods
8 since documentation is more about the content.
10 ## Document everything
16 ## If you want to avoid the whole Stage 2 build
22 First the compiler and rustdoc get built to make sure everything is okay
23 and then it documents the files.
25 ## Document specific components
28 ./x.py doc src/doc/book
29 ./x.py doc src/doc/nomicon
30 ./x.py doc src/doc/book src/libstd
33 Much like individual tests or building certain components you can build only
34 the documentation you want.
36 ## Document internal rustc items
38 Compiler documentation is not built by default. To enable it, modify config.toml:
45 Note that when enabled,
46 documentation for internal compiler items will also be built.
48 ### Compiler Documentation
50 The documentation for the rust components are found at [rustc doc].
52 [rustc doc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/