FICHA · AUR

cargo-doc2readme

cargo subcommand to create a readme file containing the rustdoc comments from...

  • cli
  • CLI
  • FILES
  • Launchable
  • Runs in terminal
official+codex · reviewed · May 30, 2026 description in en

Description

README files can be generated from Rust documentation comments in a crate. It is useful for maintainers who want project documentation to stay close to rustdoc source text.

This writes documentation files in the repository. Review generated README content before committing, because code comments may need editing for a public project overview.

How to run

cargo-doc2readme

Commands: cargo-doc2readme

Permissions

Permissions not analysed for this source yet.