knurling-rs / defmt

Efficient, deferred formatting for logging on embedded systems
https://defmt.ferrous-systems.com/
Apache License 2.0
848 stars 77 forks source link

consider bundling the mdbook with API docs served on docs.rs #433

Open japaric opened 3 years ago

japaric commented 3 years ago

This crate has en example build script that puts the mdbook in the target/doc directory.

The rendered API docs contain an mdbook that looks like this

Screenshot from 2021-03-22 16-27-13

some extra CSS is need to hide or tweak the docs.rs nav bar to get a functional mdbook.

japaric commented 3 years ago

^ we may want to do this so we get versioned mdbooks without having to set up multiple subdomains with netlify

Urhengulas commented 3 years ago

Another option we started discussing is to migrate the book to rustdoc, similar how egg does it with their tutorial: https://docs.rs/egg/0.6.0/egg/tutorials/index.html