Crate docima

docima

Usage

1. Configure your build script to generate the images in the desired path.

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. Include your image in the docs by using the doc attribute and the include_str macro.

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

3. Generate the docs:

$ cargo doc --open

Examples

The following examples are generated by this build.rs:

Inline embedding.

Structs

ImageFile

An image file generator.

Enums

DocimaError

The docima Error type.

Type Definitions

DocimaResult

The docima Result type.

StdResult

A standard Result type.