soothfast-docs 0.3.2

Soothfast docs engine: rustdoc JSON surface, bind blocks, claims, doc-test generation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

//! Soothfast docs engine.
//!
//! Four rot channels, four mechanisms:
//! - signatures can't rot: the API surface is read from rustdoc JSON
//!   ([`surface`], [`mod@reference`], [`diff`]);
//! - prose can't rot silently: bind blocks fingerprint the code they
//!   describe, locked in `soothfast.lock` ([`markdown`], [`lockfile`]);
//! - examples can't rot: every markdown `rust` block becomes a generated
//!   test, capture blocks become runnable examples ([`gentests`]);
//! - numbers can't rot: quantitative claims in prose evaluate against the
//!   latest measurement baseline ([`claims`]).

mod comments;

pub mod claims;
pub mod diff;
pub mod gentests;
pub mod lockfile;
pub mod markdown;
pub mod reference;
pub mod surface;