From 977653183ec032b83603874f0dfe0318df1f8125 Mon Sep 17 00:00:00 2001
From: Robin Mueller <robin.mueller.m@gmail.com>
Date: Wed, 15 Jan 2025 17:48:35 +0100
Subject: [PATCH] improve docs of generated library

---
 CHANGELOG.md           |  2 ++
 src/generate/device.rs |  1 +
 src/lib.rs             | 17 +++++++++++++++++
 3 files changed, 20 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d8c1c50e..0c702336 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -16,6 +16,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 - Other internal clippy fixes for `clippy::manual_div_ceil`, `clippy::nonminimal_bool` and
   `clippy::needless_lifetimes`
 - Update `svd-rs` to 0.14.11
+- Added `#![cfg_attr(docsrs, feature(doc_auto_cfg))]` to the generated library code. This
+  adds a display of the feature gates in the documentation of the generated library
 
 ## [v0.35.0] - 2024-11-12
 
diff --git a/src/generate/device.rs b/src/generate/device.rs
index d2b3ee9c..7092953a 100644
--- a/src/generate/device.rs
+++ b/src/generate/device.rs
@@ -59,6 +59,7 @@ pub fn render(d: &Device, config: &Config, device_x: &mut String) -> Result<Toke
             #![allow(non_camel_case_types)]
             #![allow(non_snake_case)]
             #![no_std]
+            #![cfg_attr(docsrs, feature(doc_auto_cfg))]
         });
     }
 
diff --git a/src/lib.rs b/src/lib.rs
index ce3779ad..a1379ef6 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -171,6 +171,23 @@
 //! v-trap = ["rt", "riscv-rt/v-trap"]
 //! ```
 //!
+//! ## Generating documentation
+//!
+//! You can generate the documentation for the generated library using the following command:
+//!
+//! ```sh
+//! RUSTDOCFLAGS="--cfg docsrs --generate-link-to-definition -Z unstable-options" cargo +nightly doc --all-features --open
+//! ```
+//!
+//! It is recommended to add the following block in the `Cargo.toml` of the generated library
+//! if you plan to host the library documentaion on `docs.rs`
+//!
+//! ```toml
+//! [package.metadata.docs.rs]
+//! all-features = true
+//! rustdoc-args = ["--generate-link-to-definition"]
+//! ```
+//!
 //! # Peripheral API
 //!
 //! To use a peripheral first you must get an *instance* of the peripheral. All the device