#cargo #crates #literate-programming #cargo-subcommand #dependencies #cli

app cargo-docco

cargo docco 从源代码生成文献编程风格的文档页面。Rust 版本的 Jash Kenas' Docco。

1 个不稳定版本

0.1.0 2020年11月6日

#685 in Cargo 插件

Apache-2.0/MIT

4MB

rocco

cargo docco

cargo docco 生成文献编程风格的文档页面。

Actions Status crates.io license license

实际应用

docco in action

安装

$ cargo install cargo-docco

(请查看 cargo 的文档 了解如何使用 cargo install 并如何设置系统以便找到 cargo 安装的二进制文件。)

用法

生成文档页面就像通过 - 标志提供 cargo docco 输入文件一样简单。

cargo docco -i source.rs [-o <optional output file name>]

如果没有提供输出文件,cargo docco 将生成一个与源文件名相同的 HTML 文件。

CLI 概览

> cargo docco -h
cargo-docco 0.1.0
Literate-style documentation generator from source code

USAGE:
    cargo docco [OPTIONS] -i <input>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -i <input>         input source file
    -o <output>        optional path to the generated output html file

支持的语言

cargo-docco 依赖于 rocco。有关支持的语言,请参阅 "支持的语言" 部分。

贡献

欢迎各种类型的贡献。

可以在 问题 中提出问题。

为了帮助我们快速顺利地合并拉取请求,在提交大改动之前请先打开一个问题。请尽量保持拉取请求和提交内容的简洁。提交信息应包括提交的意图。

支持

Buy Me A Coffee

ko-fi

许可证

根据您的选择,双重许可为 Apache 许可证,版本 2.0 或 MIT 许可证。

除非您明确说明,否则根据 Apache-2.0 许可证定义,您有意提交给此软件包的贡献将根据上述许可证双重许可,没有任何附加条款或条件。

依赖关系

~14MB
~238K SLoC