#documentation #generate-documentation #man #markdown #roff

doc-writer

Generate documentation in multiple formats

2 unstable releases

0.2.0 Aug 11, 2021
0.1.0 Aug 7, 2021

#534 in Template engine


Used in env-config

MIT/Apache

41KB
655 lines

doc-writer

Generate documentation in multiple formats. For usage information see docs.rs.

Results look like grep.md and man grep.1.

License

doc-writer is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See the LICENSE-APACHE and LICENSE-MIT files in this repository for more information.


lib.rs:

Generate documentation in multiple formats using the DocumentationWriter trait. Implementations of which can be found in the render module for man pages and Markdown files.

Generated contents look like this:

grep.md

man grep.1

Dependencies

~200KB