Repository files navigation

This crate provides a macro that extracts documentation comments from Cargo.toml

To use this crate, add#![doc = document_features::document_features!()] in your crate documentation.Thedocument_features!() macro reads yourCargo.toml file, extracts feature comments and generatesa markdown string for your documentation.

Use## and#! comments in your Cargo.toml to document features, for example:

[dependencies]document-features ="0.2"## ...[features]## The foo feature enables the `foo` functionsfoo = []## The bar feature enables the [`bar`] modulebar = []#! ### Experimental features#! The following features are experimental## Activate the fusion reactorfusion = []

These comments keep the feature definition and documentation next to each other, and they are thenrendered into your crate documentation.

Check out thedocumentation for more details.

Contributions are welcome. We accept pull requests and bug reports.

MIT OR Apache-2.0