|
- Rust Documentation
Rust’s standard library has extensive API documentation, with explanations of how to use various things, as well as example code for accomplishing various tasks Code examples have a “Run” button on hover that opens the sample in the playground
- The Rust Programming Language - The Rust Programming Language - Learn Rust
See the “Installation” section of Chapter 1 to install or update Rust The HTML format is available online at https: doc rust-lang org stable book and offline with installations of Rust made with rustup; run rustup doc --book to open Several community translations are also available
- Crate std Copy item path - Learn Rust
The Rust Standard Library is the foundation of portable Rust software, a set of minimal and battle-tested shared abstractions for the broader Rust ecosystem It offers core types, like Vec<T> and Option<T> , library-defined operations on language primitives , standard macros , I O and multithreading , among many other things
- How to write documentation - The rustdoc book - Learn Rust
There are a few tenets to Rust documentation that can help guide anyone through the process of documenting libraries so that everyone has an ample opportunity to use the code This chapter covers not only how to write documentation but specifically how to write good documentation
- Documentation - Rust By Example
Rust by Example (RBE) is a collection of runnable examples that illustrate various Rust concepts and standard libraries
- Introduction - The Rust Reference - Learn Rust
This book is the primary reference for the Rust programming language It provides three kinds of material: Chapters that informally describe each language construct and their use
- Introduction - The Rust Programming Language - Learn Rust
Chapter 1 explains how to install Rust, how to write a “Hello, world!” program, and how to use Cargo, Rust’s package manager and build tool Chapter 2 is a hands-on introduction to writing a program in Rust, having you build up a number guessing game
- What is rustdoc? - The rustdoc book - Learn Rust
The standard Rust distribution ships with a tool called rustdoc Its job is to generate documentation for Rust projects On a fundamental level, Rustdoc takes as an argument either a crate root or a Markdown file, and produces HTML, CSS, and JavaScript Basic usage Let's give it a try! Create a new project with Cargo: $ cargo new docs --lib
|
|
|