docima

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

Crate API Lines Of Code

Warning

The current API is going to evolve a lot while the major version number is 0.

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.:

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

  1. Include your image in the Rust documentation by using the doc attribute and the include_str macro.

```rust

[doc = includestr!("../images/myimage.html") ]

``` 3. Generate the docs:

sh cargo doc --open

Learning

You can refer to the crate documentation and the source code for more complete information and practical examples.

Similar crates