docs(lib): extract feature documentation from Cargo.toml

Cargo.lock

@@ -424,6 +424,15 @@ version = "0.3.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "fea41bba32d969b513997752735605054bc0dfa92b4c56bf1189f2e174be7a10"
 
+[[package]]
+name = "document-features"
+version = "0.2.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e493c573fce17f00dcab13b6ac057994f3ce17d1af4dc39bfd482b83c6eb6157"
+dependencies = [
+ "litrs",
+]
+
 [[package]]
 name = "encoding_rs"
 version = "0.8.33"
@@ -608,6 +617,7 @@ name = "git-cliff-core"
 version = "1.3.1"
 dependencies = [
  "config",
+ "document-features",
  "git-conventional",
  "git2",
  "glob",
@@ -1000,6 +1010,12 @@ version = "0.4.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "1a9bad9f94746442c783ca431b22403b519cd7fbeed0533fdd6328b2f2212128"
 
+[[package]]
+name = "litrs"
+version = "0.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f9275e0933cf8bb20f008924c0cb07a0692fe54d8064996520bf998de9eb79aa"
+
 [[package]]
 name = "log"
 version = "0.4.20"

git-cliff-core/Cargo.toml

@@ -12,6 +12,9 @@ rust-version = "1.70.0"
 
 [features]
 default = ["repo"]
+## Enable parsing commits from a git repository.
+## You can turn this off if you already have the commits to put in the
+## changelog and you don't need `git-cliff` to parse them.
 repo = ["dep:git2", "dep:glob", "dep:indexmap"]
 
 [dependencies]
@@ -28,6 +31,7 @@ toml = "0.8.6"
 lazy-regex = "3.0.2"
 next_version = "0.2.9"
 semver = "1.0.20"
+document-features = { version = "0.2.7", optional = true }
 
 [dependencies.git2]
 version = "0.18.1"
@@ -49,3 +53,7 @@ features = ["debug-embed"]
 
 [dev-dependencies]
 pretty_assertions = "1.4.0"
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

git-cliff-core/src/lib.rs

@@ -1,12 +1,11 @@
 //! A highly customizable changelog generator ⛰️
 //!
-//! ## Features
+//! The crate provides a set of optional features that can be enabled in your
+//! `Cargo.toml` file.
 //!
-//! The [cargo features](https://doc.rust-lang.org/cargo/reference/features.html)
-//! of the library are:
-//! - `repo`: Enable parsing commits from a git repository. Enabled by default.
-//!   You can turn this off if you already have the commits to put in the
-//!   changelog and you don't need `git-cliff` to parse them.
+//! ## Features
+#![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![warn(missing_docs, clippy::unwrap_used)]
 #![doc(
 	html_logo_url = "https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff.png",