#cargo-toml

macro document-features

Extract documentation for the feature flags from comments in Cargo.toml

11 releases

0.2.10 Jul 12, 2024
0.2.8 Dec 29, 2023
0.2.7 Dec 21, 2022
0.2.6 Sep 24, 2022
0.2.1 Feb 12, 2022

#119 in Development tools

Download history 65851/week @ 2024-06-14 63607/week @ 2024-06-21 69937/week @ 2024-06-28 79218/week @ 2024-07-05 90097/week @ 2024-07-12 97296/week @ 2024-07-19 110473/week @ 2024-07-26 137283/week @ 2024-08-02 158937/week @ 2024-08-09 189668/week @ 2024-08-16 139546/week @ 2024-08-23 121703/week @ 2024-08-30 129020/week @ 2024-09-06 133793/week @ 2024-09-13 159342/week @ 2024-09-20 130171/week @ 2024-09-27

576,701 downloads per month
Used in 1,333 crates (277 directly)

MIT/Apache

33KB
765 lines

Document your crate's feature flags

Crates.io Documentation

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. The document_features!() macro reads your Cargo.toml file, extracts feature comments and generates a 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` functions
foo = []
## The bar feature enables the [`bar`] module
bar = []

#! ### Experimental features
#! The following features are experimental

## Activate the fusion reactor
fusion = []

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

Check out the documentation for more details.

Contributions

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

License

MIT OR Apache-2.0

Dependencies

~170KB