11 releases (6 breaking)

0.21.1 Jun 9, 2023
0.20.0 Nov 7, 2022
0.12.0 Jul 31, 2022
0.11.0 Dec 15, 2021
0.9.0 Jul 22, 2021

#163 in Rust patterns

Download history 475/week @ 2024-02-26 740/week @ 2024-03-04 934/week @ 2024-03-11 816/week @ 2024-03-18 668/week @ 2024-03-25 843/week @ 2024-04-01 695/week @ 2024-04-08 680/week @ 2024-04-15 899/week @ 2024-04-22 798/week @ 2024-04-29 819/week @ 2024-05-06 1006/week @ 2024-05-13 997/week @ 2024-05-20 1230/week @ 2024-05-27 1169/week @ 2024-06-03 750/week @ 2024-06-10

4,170 downloads per month
Used in 14 crates (3 directly)

MIT license

220KB
5K SLoC

Doku   crates-badge docs-badge

Doku is a framework for documenting Rust data structures - it allows to generate aesthetic, human-friendly descriptions of configuration types, requests / responses, and so on.

Say goodbye to stale, hand-written documentation - with Doku, code is the documentation!

Example

[dependencies]
doku = "0.21"
use doku::Document;
use serde::Deserialize;

#[derive(Deserialize, Document)]
struct Config {
    /// Database's engine
    db_engine: DbEngine,

    /// Database's host
    #[doku(example = "localhost")]
    db_host: String,

    /// Database's port
    #[doku(example = "5432")]
    db_port: usize,
}

#[derive(Deserialize, Document)]
enum DbEngine {
    #[serde(rename = "pgsql")]
    PostgreSQL,

    #[serde(rename = "mysql")]
    MySQL,
}

fn main() {
    println!("```json");
    println!("{}", doku::to_json::<Config>());
    println!("```");
    println!();
    println!("```toml");
    println!("{}", doku::to_toml::<Config>());
    println!("```");
}
{
  // Database's engine
  "db_engine": "pgsql" | "mysql",
  // Database's host
  "db_host": "localhost",
  // Database's port
  "db_port": 5432
}
# Database's engine
db_engine = "pgsql" | "mysql"

# Database's host
db_host = "localhost"

# Database's port
db_port = 5432

You'll find more examples in ./doku/examples; there's also a documentation at https://docs.rs/doku/.

Contributing

Found a bug, have an idea? Please let us know on GitHub - patches are welcome, too!

If you want to try hacking on Doku, the entry points are:

There are also integration tests at ./doku/tests.

License

Licensed under the MIT license.

Dependencies

~2–3MB
~69K SLoC