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
576,701 downloads per month
Used in 1,333 crates
(277 directly)
33KB
765 lines
Document your crate's feature flags
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