You might want to build documentation of the various components
available like the standard library. There’s two ways to go about this.
You can run rustdoc directly on the file to make sure the HTML is
correct, which is fast. Alternatively, you can build the documentation
as part of the build process through
x.py. Both are viable methods
since documentation is more about the content.
This uses the beta rustdoc, which usually but not always has the same output as stage 1 rustdoc.
./x.py doc --stage 1
First the compiler and rustdoc get built to make sure everything is okay and then it documents the files.
./x.py doc src/doc/book ./x.py doc src/doc/nomicon ./x.py doc src/doc/book library/std
Much like individual tests or building certain components you can build only the documentation you want.
Compiler documentation is not built by default. To enable it, modify config.toml:
[build] compiler-docs = true
Note that when enabled, documentation for internal compiler items will also be built.
The documentation for the Rust components are found at rustc doc.