使用 Homebrew 安装 cargo-docset

项目链接

• 主页

命令和别名

• cargo-docset

项目历史

The GitHub repository was created in August 2019, and the crate was published on crates.io the same month. The README defines the tool around generating Dash/Zeal docsets for Rust packages and their dependencies.

Rather than parsing Rust items directly, cargo-docset runs Cargo to generate documentation, walks the generated documentation directory, and fills a SQLite database in the docset format. That implementation choice keeps the project small and aligned with rustdoc output.

采用历史

Adoption appears specialized: the supplied package-manager facts list Homebrew and Nix packages, and crates.io shows modest lifetime downloads. It fits a narrower offline-documentation workflow than general Cargo dependency or build tooling.

使用方式

Users run `cargo docset` in a crate directory. By default the generated docset is placed in `target/docset`, then copied into the Dash or Zeal docset directory.

The command supports many `cargo doc`-style options, including feature flags, package selection, target selection, workspace generation, and private item documentation.

为什么软件包爱好者会关心

cargo-docset is interesting because it bridges Rust's native rustdoc output with the older Dash/Zeal docset ecosystem. It shows how package metadata, generated HTML, and SQLite indexes can be stitched together without inventing a new documentation browser.

For maintainers who work offline or across many local crates, it packages a workspace's documentation into a format that external developer tools already understand.

时间线

• 2019: Robzz/cargo-docset GitHub repository created.
• 2019: cargo-docset crate first published on crates.io.
• 2022: crates.io metadata shows the 0.3.1 release as the current line.

Related projects

• rustdoc and `cargo doc` generate the HTML documentation that cargo-docset packages.
• Dash and Zeal are the docset browsers targeted by the generated output.
• SQLite is used by the Dash docset format for indexing.

来源

• https://api.github.com/repos/Robzz/cargo-docset
• https://crates.io/api/v1/crates/cargo-docset
• https://github.com/Robzz/cargo-docset#readme
• https://raw.githubusercontent.com/Robzz/cargo-docset/master/README.md
• input.source_facts.package-manager