File tree Expand file tree Collapse file tree 1 file changed +7
-17
lines changed Expand file tree Collapse file tree 1 file changed +7
-17
lines changed Original file line number Diff line number Diff line change @@ -9,13 +9,13 @@ since documentation is more about the content.
99
1010## Document everything
1111
12- ``` ignore
12+ ``` bash
1313./x.py doc
1414```
1515
1616## If you want to avoid the whole Stage 2 build
1717
18- ``` ignore
18+ ``` bash
1919./x.py doc --stage 1
2020```
2121
@@ -24,7 +24,7 @@ and then it documents the files.
2424
2525## Document specific components
2626
27- ``` ignore
27+ ``` bash
2828./x.py doc src/doc/book
2929./x.py doc src/doc/nomicon
3030./x.py doc src/doc/book src/libstd
@@ -35,25 +35,15 @@ Much like individual tests or building certain components you can build only
3535
3636## Document internal rustc items
3737
38- Compiler documentation is not built by default. There's a flag in
39- config.toml for achieving the same.
40- But, when enabled, compiler documentation does include internal items.
41-
42- Next open up config.toml and make sure these two lines are set to true:
38+ Compiler documentation is not built by default. To enable it, modify config.toml:
4339
4440``` toml
45- docs = true
41+ [ build ]
4642compiler-docs = true
4743```
4844
49- When you want to build the compiler docs as well run this command:
50-
51- ``` ignore
52- ./x.py doc
53- ```
54-
55- This will see that the docs and compiler-docs options are set to true
56- and build the normally hidden compiler docs!
45+ Note that when enabled,
46+ documentation for internal compiler items will also be built.
5747
5848### Compiler Documentation
5949
You can’t perform that action at this time.
0 commit comments