rustdoc

Generate documentation for a Rust crate. More information: <https://doc.rust-lang.org/stable/rustdoc>.

Install

All systems
curl cmd.cat/rustdoc.sh
Debian Debian
apt-get install rustc
Ubuntu
apt-get install rustc
Alpine
apk add rust
Arch Arch Linux
pacman -S rust
image/svg+xml Kali Linux
apt-get install rustc
Fedora
dnf install rust
Windows (WSL2)
sudo apt-get update sudo apt-get install rustc
OS X
brew install rust
Raspbian
apt-get install rustc
Dockerfile
dockerfile.run/rustdoc
Docker
docker run cmd.cat/rustdoc rustdoc powered by Commando

Generate documentation for a Rust crate. More information: <https://doc.rust-lang.org/stable/rustdoc>.

  • Generate documentation from the crate's root:
    rustdoc src/lib.rs
  • Pass a name for the project:
    rustdoc src/lib.rs --crate-name name
  • Generate documentation from Markdown files:
    rustdoc path/to/file.md
  • Specify the output directory:
    rustdoc src/lib.rs --out-dir path/to/output_directory

© tl;dr; authors and contributors