Crate docmatic [] [src]

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");
}

Functions

assert_file
assert_file_impl