Skip to content

fix some whitespace issues #483

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 1 commit into from
Oct 28, 2019
Merged
Changes from all 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
30 changes: 15 additions & 15 deletions src/compiler-documenting.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Documenting rustc

You might want to build documentation of the various components
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
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.

## Document everything

```bash
./x.py doc
```
```ignore
./x.py doc
```

## If you want to avoid the whole Stage 2 build

```bash
```ignore
./x.py doc --stage 1
```

Expand All @@ -24,10 +24,10 @@ and then it documents the files.

## Document specific components

```bash
./x.py doc src/doc/book
./x.py doc src/doc/nomicon
./x.py doc src/doc/book src/libstd
```ignore
./x.py doc src/doc/book
./x.py doc src/doc/nomicon
./x.py doc src/doc/book src/libstd
```

Much like individual tests or building certain components you can build only
Expand All @@ -41,14 +41,14 @@ But, when enabled, compiler documentation does include internal items.

Next open up config.toml and make sure these two lines are set to true:

```bash
```toml
docs = true
compiler-docs = true
```

When you want to build the compiler docs as well run this command:

```bash
```ignore
./x.py doc
```

Expand All @@ -59,4 +59,4 @@ and build the normally hidden compiler docs!

The documentation for the rust components are found at [rustc doc].

[rustc doc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
[rustc doc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/