Google Git
Sign in
rust / rust-by-example / 8a63d8bb8d620554ae0cb019d6494d8f7db13f92
commit8a63d8bb8d620554ae0cb019d6494d8f7db13f92[log] [tgz]
authormautam <mautam@usa.com>Fri May 30 19:43:14 2025 -0400
committermautam <mautam@usa.com>Fri May 30 19:53:04 2025 -0400
tree1a21e9633ec92ece45b37ab29c7520af47073295
parent21f4e32b8b40d36453fae16ec07ad4b857c445b6 [diff]
fix(#1656): update doc tests to use `playground` as the crate name

This updates the Documentation Testing (21.2) chapter to assume a crate
name of `playground` instead of `doccomments`. This allows for the code
contained within to be copy-pasted directly into play.rust-lang.org to
run; anyone who would want to reproduce this locally would want to
create a `playground` library.

Fixes #1656.
4 files changed
tree: 1a21e9633ec92ece45b37ab29c7520af47073295
  1. .github/
  2. po/
  3. src/
  4. theme/
  5. .gitattributes
  6. .gitignore
  7. book.toml
  8. CODE_OF_CONDUCT.md
  9. CONTRIBUTING.md
  10. LICENSE-APACHE
  11. LICENSE-MIT
  12. README.md
  13. TRANSLATING.md
  14. TRANSLATING_JA.md
  15. TRANSLATING_ZH.md
  16. triagebot.toml
README.md

Rust By Example

Build Status

Learn Rust with examples (Live code editor included)

Using

If you'd like to read Rust by Example, you can visit https://doc.rust-lang.org/rust-by-example/ to read it online.

If you'd like to read it locally, install Rust, and then:

git clone https://github.com/rust-lang/rust-by-example
cd rust-by-example
cargo install mdbook
mdbook build
mdbook serve

To be able to run the examples, you must be connected to the internet; you can read all content offline, however!

The following warnings can be ignored safely.

[WARN] (mdbook::preprocess::cmd): The command wasn't found, is the "gettext" preprocessor installed?
[WARN] (mdbook::preprocess::cmd):   Command: mdbook-gettext

Using translated version

If there is a translated resource in po/ directory, it can be specified through MDBOOK_BOOK__LANGUAGE like below:

git clone https://github.com/rust-lang/rust-by-example
cd rust-by-example
cargo install mdbook
MDBOOK_BOOK__LANGUAGE=ja mdbook build
MDBOOK_BOOK__LANGUAGE=ja mdbook serve

Contributing

Please see the CONTRIBUTING.md file for more details.

Translating

Please see the TRANSLATING.md file for more details.

Translating guide for each languages

Translations to other languages

License

Rust by Example is licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Rust by Example by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any additional terms or conditions.