Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rust-lang/reference
The Rust Reference
https://github.com/rust-lang/reference
documentation reference rust rust-lang
Last synced: 2 days ago
JSON representation
The Rust Reference
- Host: GitHub
- URL: https://github.com/rust-lang/reference
- Owner: rust-lang
- License: apache-2.0
- Created: 2017-03-01T16:21:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T21:37:41.000Z (2 months ago)
- Last Synced: 2024-10-29T15:45:36.718Z (about 2 months ago)
- Topics: documentation, reference, rust, rust-lang
- Language: Rust
- Homepage: https://doc.rust-lang.org/nightly/reference/
- Size: 4.49 MB
- Stars: 1,239
- Watchers: 40
- Forks: 483
- Open Issues: 318
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# The Rust Language Reference
This document is the primary reference for the Rust programming
language.
This document is not normative. It may include details that are specific
to `rustc` itself, and should not be taken as a specification for the
Rust language. We intend to produce such a document someday, but this is
what we have for now.
## Dependencies
- Nightly Rust
- [mdbook](https://rust-lang.github.io/mdBook/)
## Installing dependencies
First, ensure that you have a recent copy of the nightly Rust compiler
installed, as this is needed in order to run the tests:
```sh
rustup toolchain install nightly
```
Now, ensure you have `mdbook` installed, as this is needed in order to
build the Reference:
```sh
cargo install --locked mdbook
```
## Building
To build the Reference, first clone the project:
```sh
git clone https://github.com/rust-lang/reference.git
```
(Alternatively, if you don't want to use `git`, [download][] a ZIP file
of the project, extract it using your preferred tool, and rename the
top-level directory to `reference`.)
[download]: https://github.com/rust-lang/reference/archive/refs/heads/master.zip
Now change your current directory to the working directory:
```sh
cd reference
```
To test all of the code examples in the Reference, run:
```sh
mdbook test
```
For authors, consider using the server functionality which supports automatic reload.
To build the Reference locally (in `build/`) and open it in a web
browser, run:
```sh
SPEC_RELATIVE=0 mdbook build --open
```
This will open a browser with a websocket live-link to automatically reload whenever the source is updated.
You can also use mdbook's live webserver option, which will automatically rebuild the book and reload your web browser whenever a source file is modified:
```sh
SPEC_RELATIVE=0 mdbook serve --open
```
### `SPEC_RELATIVE`
The `SPEC_RELATIVE=0` environment variable makes links to the standard library go to instead of being relative, which is useful when viewing locally since you normally don't have a copy of the standard library.
The published site at (or local docs using `rustup doc`) does not set this, which means it will use relative links which supports offline viewing and links to the correct version (for example, links in will stay within the 1.81.0 directory).
### `SPEC_DENY_WARNINGS`
The `SPEC_DENY_WARNINGS=1` environment variable will turn all warnings generated by `mdbook-spec` to errors. This is used in CI to ensure that there aren't any problems with the book content.
### `SPEC_RUST_ROOT`
The `SPEC_RUST_ROOT` can be used to point to the directory of a checkout of . This is used by the test-linking feature so that it can find tests linked to reference rules. If this is not set, then the tests won't be linked.