trim down "Document rustc"
This commit is contained in:
parent
a1b8f5a26a
commit
b99a1d9554
|
|
@ -9,13 +9,13 @@ since documentation is more about the content.
|
||||||
|
|
||||||
## Document everything
|
## Document everything
|
||||||
|
|
||||||
```ignore
|
```bash
|
||||||
./x.py doc
|
./x.py doc
|
||||||
```
|
```
|
||||||
|
|
||||||
## If you want to avoid the whole Stage 2 build
|
## If you want to avoid the whole Stage 2 build
|
||||||
|
|
||||||
```ignore
|
```bash
|
||||||
./x.py doc --stage 1
|
./x.py doc --stage 1
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -24,7 +24,7 @@ and then it documents the files.
|
||||||
|
|
||||||
## Document specific components
|
## Document specific components
|
||||||
|
|
||||||
```ignore
|
```bash
|
||||||
./x.py doc src/doc/book
|
./x.py doc src/doc/book
|
||||||
./x.py doc src/doc/nomicon
|
./x.py doc src/doc/nomicon
|
||||||
./x.py doc src/doc/book src/libstd
|
./x.py doc src/doc/book src/libstd
|
||||||
|
|
@ -35,25 +35,15 @@ Much like individual tests or building certain components you can build only
|
||||||
|
|
||||||
## Document internal rustc items
|
## Document internal rustc items
|
||||||
|
|
||||||
Compiler documentation is not built by default. There's a flag in
|
Compiler documentation is not built by default. To enable it, modify config.toml:
|
||||||
config.toml for achieving the same.
|
|
||||||
But, when enabled, compiler documentation does include internal items.
|
|
||||||
|
|
||||||
Next open up config.toml and make sure these two lines are set to true:
|
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
docs = true
|
[build]
|
||||||
compiler-docs = true
|
compiler-docs = true
|
||||||
```
|
```
|
||||||
|
|
||||||
When you want to build the compiler docs as well run this command:
|
Note that when enabled,
|
||||||
|
documentation for internal compiler items will also be built.
|
||||||
```ignore
|
|
||||||
./x.py doc
|
|
||||||
```
|
|
||||||
|
|
||||||
This will see that the docs and compiler-docs options are set to true
|
|
||||||
and build the normally hidden compiler docs!
|
|
||||||
|
|
||||||
### Compiler Documentation
|
### Compiler Documentation
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue