File tree 1 file changed +7
-17
lines changed
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.
9
9
10
10
## Document everything
11
11
12
- ``` ignore
12
+ ``` bash
13
13
./x.py doc
14
14
```
15
15
16
16
## If you want to avoid the whole Stage 2 build
17
17
18
- ``` ignore
18
+ ``` bash
19
19
./x.py doc --stage 1
20
20
```
21
21
@@ -24,7 +24,7 @@ and then it documents the files.
24
24
25
25
## Document specific components
26
26
27
- ``` ignore
27
+ ``` bash
28
28
./x.py doc src/doc/book
29
29
./x.py doc src/doc/nomicon
30
30
./x.py doc src/doc/book src/libstd
@@ -35,25 +35,15 @@ Much like individual tests or building certain components you can build only
35
35
36
36
## Document internal rustc items
37
37
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:
43
39
44
40
``` toml
45
- docs = true
41
+ [ build ]
46
42
compiler-docs = true
47
43
```
48
44
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.
57
47
58
48
### Compiler Documentation
59
49
You can’t perform that action at this time.
0 commit comments