docima

在构建时生成图像以嵌入到Rust文档中。

警告

当前API将在主要版本号为0时发生很大变化。

用法

1. 首先配置您的构建脚本来在所需路径中生成图像。它们将被编码为 png → base64 并保存为 HTML 标签。例如。

ImageFile::new()
    .path("images/my_image.html")
    .width(600)
    .height(400)
    .attr("title", "My image")
    .attr("id", "image-01")
    .attr("style", "display: block; margin:auto;")
    .wrapper("div")
    .wrapper_attr("style", "background-color:red; padding:3px;")
    .overwrite(true)
    .generate(my_image_generator_function)?;

2. 通过使用 doc 属性和 include_str 宏将图像包含在Rust文档中。

#[doc = include_str!("../images/my_image.html") ]

3. 生成文档

cargo doc --open

功能

有几个功能允许自定义默认值。

not_default_overwrite

默认情况下，所有图像都将始终生成，即使目标文件已经存在。通过使用此功能，您可以避免在文件存在时生成。

注意，您始终可以通过使用 overwrite 方法来覆盖默认值。

build_when_doc

启用此功能后，图像只有在以下 doc 功能也使用时才会生成。

这在您需要始终覆盖生成的文件但不想在正常编译源代码时生成图像时非常有用。

doc

手动使用此功能，与 build_when_doc 一起使用。

您必须使用以下示例作为模型来自定义您的设置

添加到 Cargo.toml

[features]
doc = ["docima/doc"]

[build-dependencies]
docima = { version = "*", features = ["build_when_doc"] }

然后图像将 仅 在您使用此功能时生成，如下所示

doc --features=doc

为了方便起见，您可以在 .cargo/config.toml 中创建一个新的别名

[alias]
docdoc = "doc --features=doc"

更多信息

您可以通过查阅文档和源代码来获取更完整的信息和实用示例。

类似crate

• embed-doc-image