[rustc.git] / src / doc / rustc-dev-guide / src / building / compiler-documenting.md

# Documenting rustc

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.

## Document everything

```bash
./x.py doc
```

## If you want to avoid the whole Stage 2 build

```bash
./x.py doc --stage 1
```

First the compiler and rustdoc get built to make sure everything is okay
and then it documents the files.

## Document specific components

```bash
./x.py doc src/doc/book
./x.py doc src/doc/nomicon
./x.py doc src/doc/book src/libstd
```

Much like individual tests or building certain components you can build only
 the documentation you want.

## Document internal rustc items

Compiler documentation is not built by default. To enable it, modify config.toml:

```toml
[build]
compiler-docs = true
```

Note that when enabled,
documentation for internal compiler items will also be built.

### Compiler Documentation

The documentation for the rust components are found at [rustc doc].

[rustc doc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/
Commit	Line	Data
60c5eb7d XL	1	# Documenting rustc
	2
	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.
	9
	10	## Document everything
	11
	12	```bash
	13	./x.py doc
	14	```
	15
	16	## If you want to avoid the whole Stage 2 build
	17
	18	```bash
	19	./x.py doc --stage 1
	20	```
	21
	22	First the compiler and rustdoc get built to make sure everything is okay
	23	and then it documents the files.
	24
	25	## Document specific components
	26
	27	```bash
	28	./x.py doc src/doc/book
	29	./x.py doc src/doc/nomicon
	30	./x.py doc src/doc/book src/libstd
	31	```
	32
	33	Much like individual tests or building certain components you can build only
	34	the documentation you want.
	35
	36	## Document internal rustc items
	37
	38	Compiler documentation is not built by default. To enable it, modify config.toml:
	39
	40	```toml
	41	[build]
	42	compiler-docs = true
	43	```
	44
	45	Note that when enabled,
	46	documentation for internal compiler items will also be built.
	47
	48	### Compiler Documentation
	49
	50	The documentation for the rust components are found at [rustc doc].
	51
ba9703b0	52	[rustc doc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/