Skip to content

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 6 commits into from
Jul 31, 2022
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 34 additions & 39 deletions src/building/compiler-documenting.md
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,
like the standard library (std) or the compiler (rustc).

## 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 gets built to make sure rustdoc compiles,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is super nitpicky and you can ignore it if you like, but I still feel like "make sure rustdoc compiles" is ambiguous. We're not checking that it compiles, we're actually compiling it. I would be less worried about this if it weren't for the fact that check is a cargo/x.py subcommand 😅

Maybe it makes more sense to just say "first rustdoc is built," ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

glad you are "nitpicky"... was not too happy with it, so thanks for this

then that newly-built rustdoc is used to document the components.

## 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`:

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/