Make docs look better

We also enable bluetooth-le for the docs. In addition, the doc_cfg
attribute marks the required feature for each module/struct/method/...

Author: lukipuki

Cargo.toml

@@ -3,6 +3,7 @@ name = "meshtastic"
 description = "A Rust library for communicating with and configuring Meshtastic devices."
 homepage = "https://meshtastic.org/"
 repository = "https://github.com/meshtastic/rust"
+documentation = "https://docs.rs/heapless"
 keywords = ["meshtastic", "mesh", "lora", "tcp", "serial"]
 categories = ["embedded", "config", "encoding"]
 authors = ["Adam McQuilkin"]
@@ -83,3 +84,7 @@ bluez-async = { version = "=0.8.0", optional = true }
 [dev-dependencies]
 fern = { version = "0.7.1", features = ["colored"] }
 humantime = "2.1.0"
+
+[package.metadata.docs.rs]
+features = ["bluetooth-le"]
+rustdoc-args = ["--cfg", "docsrs"]

src/connections/handlers.rs

@@ -15,7 +15,7 @@ use crate::connections::stream_buffer::StreamBuffer;
 use super::wrappers::encoded_data::IncomingStreamData;
 
 /// Interval for sending heartbeat packets to the radio (in seconds).
-/// Needs to be less than this: https://github.com/meshtastic/firmware/blob/eb372c190ec82366998c867acc609a418130d842/src/SerialConsole.cpp#L8
+/// Needs to be less than this: <https://github.com/meshtastic/firmware/blob/eb372c190ec82366998c867acc609a418130d842/src/SerialConsole.cpp#L8>
 pub const CLIENT_HEARTBEAT_INTERVAL: u64 = 5 * 60; // 5 minutes
 
 pub fn spawn_read_handler<R>(

src/generated/meshtastic.rs

@@ -7862,7 +7862,7 @@ pub struct GeoChat {
 }
 ///
 /// ATAK Group
-/// <__group role='Team Member' name='Cyan'/>
+/// `<__group role='Team Member' name='Cyan'/>`
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
 #[cfg_attr(feature = "ts-gen", derive(specta::Type))]
@@ -7880,7 +7880,7 @@ pub struct Group {
 }
 ///
 /// ATAK EUD Status
-/// <status battery='100' />
+/// `<status battery='100' />`
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
 #[cfg_attr(feature = "ts-gen", derive(specta::Type))]
@@ -7893,7 +7893,7 @@ pub struct Status {
 }
 ///
 /// ATAK Contact
-/// <contact endpoint='0.0.0.0:4242:tcp' phone='+12345678' callsign='FALKE'/>
+/// `<contact endpoint='0.0.0.0:4242:tcp' phone='+12345678' callsign='FALKE'/>`
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
 #[cfg_attr(feature = "ts-gen", derive(specta::Type))]

src/lib.rs

@@ -1,3 +1,5 @@
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 //! A Rust library for communicating with and configuring Meshtastic devices.
 #[cfg(feature = "tokio")]
 pub(crate) mod connections;