Crate docmatic

docmatic:

docmatic runs rustdoc on your documentation files.

Writing code blocks

See “Documentation tests” for how to customize your code blocks being run as tests.

Example

First, add this to your Cargo.toml:

[dev-dependencies]
docmatic = "0.1"

Next, in your test file:

extern crate docmatic;

fn test_readme() {
    docmatic::assert_file("README.md");
}

Structs

Assert

A specialized process builder managing a rustdoc test session.

Functions

assert_file

Test a single file with default parameters.