-
Notifications
You must be signed in to change notification settings - Fork 543
revamp doc-build chapter #1402
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
revamp doc-build chapter #1402
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
66f0e32
revamp doc-build chapter
tshepang 9355ef4
Update src/building/compiler-documenting.md
tshepang 431ada1
summary of chapter
tshepang 90c7bc2
try address review comments
tshepang 8b3d8b1
accept review suggestion
tshepang e447e36
address review comment
tshepang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,55 +1,50 @@ | ||
# Building documentation | ||
|
||
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 chapter describes how to build documentation of toolchain components, | ||
either in whole or individually. | ||
|
||
## Document everything | ||
- Document everything | ||
|
||
This uses the beta rustdoc, which usually but not always has the same output | ||
as stage 1 rustdoc. | ||
This uses `rustdoc` from the beta toolchain, | ||
so will produce (slightly) different output to stage 1 rustdoc, | ||
as `rustdoc` is under active development: | ||
|
||
```bash | ||
./x.py doc | ||
``` | ||
```bash | ||
./x.py doc | ||
``` | ||
|
||
## If you want to be sure that the links behave the same as on CI | ||
If you want to be sure the documentation looks the same as on CI: | ||
|
||
```bash | ||
./x.py doc --stage 1 | ||
``` | ||
```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. | ||
First, | ||
the compiler and rustdoc get built to make sure everything is okay, | ||
and then it documents the files. | ||
|
||
## Document specific components | ||
- Much like running individual tests or building specific components, | ||
you can build just the documentation you want: | ||
|
||
```bash | ||
./x.py doc src/doc/book | ||
./x.py doc src/doc/nomicon | ||
./x.py doc src/doc/book library | ||
``` | ||
```bash | ||
./x.py doc src/doc/book | ||
./x.py doc src/doc/nomicon | ||
./x.py doc compiler library | ||
``` | ||
|
||
Much like individual tests or building certain components you can build only | ||
the documentation you want. | ||
- Document internal rustc items | ||
|
||
## Document internal rustc items | ||
Compiler documentation is not built by default. | ||
To enable it, modify `config.toml`: | ||
tshepang marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Compiler documentation is not built by default. To enable it, modify config.toml: | ||
```toml | ||
[build] | ||
compiler-docs = true | ||
``` | ||
|
||
```toml | ||
[build] | ||
compiler-docs = true | ||
``` | ||
Note that when enabled, | ||
documentation for internal compiler items will also be built. | ||
|
||
Note that when enabled, | ||
documentation for internal compiler items will also be built. | ||
NOTE: The documentation for the compiler is found at [this link]. | ||
|
||
### 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/ | ||
[this link]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/ |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm, this sentence is saying a lot of complicated things in very few words.
unless it's talking about stage1, in which case it's just completely wrong - the reason you have to build rustdoc is so you can run it, because it might be different from the beta rustdoc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(this is also one of the few cases where
--keep-stage 0
is sound - if you've only modified documentation, it can't affect the build artifacts, so it's ok to only rebuild the documentation and not rustdoc itself.)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure how much detail to provide, but please have a look at the small change I made