docima 0.1.0

Generate images at build time & embed them in the Rust documentation
Documentation

docima

Generate images at build time for embedding in the Rust documentation.

Crate API Lines Of Code

Usage

  1. First configure your build script to generate the images in the desired path. They will be encoded as png → base64 and saved as HTML tags. E.g.:
generate_image(
    my_image_generator_function,
    600,
    400,
    "images/my_image.html",
    "the alt-text attribute",
    "the title attribute",
    "div",
)?;
  1. Include your image in the Rust documentation by using the doc attribute and the include_str macro.
#[doc = include_str!("../images/my_image.html") ]
  1. Generate the docs:
cargo doc --open

You can refer to the crate documentation for more details. And there's also a full practical example available.

Similar crates