generate docs for feature gated items

codegen/Cargo.toml

@@ -40,3 +40,10 @@ bitvec = { workspace = true }
 scale-info = { workspace = true, features = ["bit-vec"] }
 pretty_assertions = { workspace = true }
 frame-metadata = { workspace = true }
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[package.metadata.playground]
+all-features = true

codegen/src/lib.rs

@@ -7,6 +7,7 @@
 //! be used directly if preferable.
 
 #![deny(unused_crate_dependencies, missing_docs)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 mod api;
 mod ir;
@@ -18,6 +19,7 @@ pub mod error;
 // macro and CLI tool, so they only live here because this is a common
 // crate that both depend on.
 #[cfg(feature = "fetch-metadata")]
+#[cfg_attr(docsrs, doc(cfg(feature = "fetch-metadata")))]
 pub mod fetch_metadata;
 
 #[cfg(feature = "web")]

lightclient/Cargo.toml

@@ -80,3 +80,10 @@ pin-project = { workspace = true, optional = true }
 
 # Included if "web" feature is enabled, to enable its js feature.
 getrandom = { workspace = true, optional = true }
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[package.metadata.playground]
+all-features = true

lightclient/src/lib.rs

@@ -10,6 +10,8 @@
 //!
 //! This leverages the smoldot crate to connect to the chain.
 
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 #[cfg(any(
     all(feature = "web", feature = "native"),
     not(any(feature = "web", feature = "native"))
@@ -35,6 +37,7 @@ pub mod smoldot {
     };
 
     #[cfg(feature = "native")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "native")))]
     pub use smoldot_light::platform::default::DefaultPlatform;
 }
 

signer/Cargo.toml

@@ -58,3 +58,10 @@ sp-keyring = { workspace = true }
 
 [package.metadata.cargo-machete]
 ignored = ["getrandom"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[package.metadata.playground]
+all-features = true

signer/src/lib.rs

@@ -13,16 +13,20 @@
 //! Enable the `subxt` feature to enable use of this [`sr25519::Keypair`] in signing
 //! subxt transactions for chains supporting sr25519 signatures.
 
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 #[macro_use]
 mod utils;
 mod crypto;
 
 // An sr25519 key pair implementation.
 #[cfg(feature = "sr25519")]
+#[cfg_attr(docsrs, doc(cfg(feature = "sr25519")))]
 pub mod sr25519;
 
 // An ecdsa key pair implementation.
 #[cfg(feature = "ecdsa")]
+#[cfg_attr(docsrs, doc(cfg(feature = "ecdsa")))]
 pub mod ecdsa;
 
 // Re-export useful bits and pieces for generating a Pair from a phrase,

signer/src/sr25519.rs

@@ -245,6 +245,7 @@ pub mod dev {
 // Make `Keypair` usable to sign transactions in Subxt. This is optional so that
 // `subxt-signer` can be used entirely independently of Subxt.
 #[cfg(feature = "subxt")]
+#[cfg_attr(docsrs, doc(cfg(feature = "subxt")))]
 mod subxt_compat {
     use super::*;
 

subxt/Cargo.toml

@@ -122,3 +122,10 @@ required-features = ["unstable-light-client", "jsonrpsee"]
 name = "light_client_parachains"
 path = "examples/light_client_parachains.rs"
 required-features = ["unstable-light-client", "jsonrpsee", "native"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[package.metadata.playground]
+all-features = true

subxt/src/backend/rpc/mod.rs

@@ -57,6 +57,7 @@
 #![allow(clippy::module_inception)]
 
 #[cfg(feature = "jsonrpsee")]
+#[cfg_attr(docsrs, doc(cfg(feature = "jsonrpsee")))]
 mod jsonrpsee_impl;
 
 mod rpc_client;

subxt/src/backend/rpc/rpc_client.rs

@@ -19,6 +19,7 @@ pub struct RpcClient {
 
 impl RpcClient {
     #[cfg(feature = "jsonrpsee")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "jsonrpsee")))]
     /// Create a default RPC client pointed at some URL, currently based on [`jsonrpsee`].
     pub async fn from_url<U: AsRef<str>>(url: U) -> Result<Self, Error> {
         let client = jsonrpsee_helpers::client(url.as_ref())

subxt/src/client/light_client/builder.rs

@@ -100,6 +100,7 @@ impl<T: Config> LightClientBuilder<T> {
     /// If smoldot panics, then the promise created will be leaked. For more details, see
     /// https://docs.rs/wasm-bindgen-futures/latest/wasm_bindgen_futures/fn.future_to_promise.html.
     #[cfg(feature = "jsonrpsee")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "jsonrpsee")))]
     pub async fn build_from_url<Url: AsRef<str>>(self, url: Url) -> Result<LightClient<T>, Error> {
         let chain_spec = fetch_url(url.as_ref()).await?;
 
@@ -245,6 +246,7 @@ async fn fetch_url(url: impl AsRef<str>) -> Result<serde_json::Value, Error> {
 }
 
 #[cfg(all(feature = "jsonrpsee", feature = "native"))]
+#[cfg_attr(docsrs, doc(cfg(all(feature = "jsonrpsee", feature = "native"))))]
 mod jsonrpsee_helpers {
     use crate::error::{Error, LightClientError};
     pub use jsonrpsee::{

subxt/src/client/mod.rs

@@ -12,6 +12,7 @@ mod offline_client;
 mod online_client;
 
 #[cfg(feature = "unstable-light-client")]
+#[cfg_attr(docsrs, doc(cfg(feature = "unstable-light-client")))]
 mod light_client;
 
 pub use offline_client::{OfflineClient, OfflineClientT};
@@ -20,6 +21,7 @@ pub use online_client::{
 };
 
 #[cfg(feature = "unstable-light-client")]
+#[cfg_attr(docsrs, doc(cfg(feature = "unstable-light-client")))]
 pub use light_client::{
     LightClient, LightClientBuilder, LightClientError, RawLightClient, RawLightClientBuilder,
 };

subxt/src/client/online_client.rs

@@ -56,6 +56,7 @@ impl<T: Config> std::fmt::Debug for OnlineClient<T> {
 
 // The default constructors assume Jsonrpsee.
 #[cfg(feature = "jsonrpsee")]
+#[cfg_attr(docsrs, doc(cfg(feature = "jsonrpsee")))]
 impl<T: Config> OnlineClient<T> {
     /// Construct a new [`OnlineClient`] using default settings which
     /// point to a locally running node on `ws://127.0.0.1:9944`.

subxt/src/config/mod.rs

@@ -127,6 +127,7 @@ pub trait Header: Sized + Encode + Decode {
 
 /// implement subxt's Hasher and Header traits for some substrate structs
 #[cfg(feature = "substrate-compat")]
+#[cfg_attr(docsrs, doc(cfg(feature = "substrate-compat")))]
 mod substrate_impls {
     use super::*;
 

subxt/src/error/mod.rs

@@ -9,6 +9,7 @@ mod dispatch_error;
 use core::fmt::Debug;
 
 #[cfg(feature = "unstable-light-client")]
+#[cfg_attr(docsrs, doc(cfg(feature = "unstable-light-client")))]
 pub use crate::client::LightClientError;
 
 // Re-export dispatch error types:
@@ -73,6 +74,7 @@ pub enum Error {
     Unknown(Vec<u8>),
     /// Light client error.
     #[cfg(feature = "unstable-light-client")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "unstable-light-client")))]
     #[error("An error occurred but it could not be decoded: {0}")]
     LightClient(#[from] LightClientError),
     /// Other error.

subxt/src/lib.rs

@@ -10,6 +10,8 @@
 //!
 //! Take a look at [the Subxt guide](book) to learn more about how to use Subxt.
 
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 #[cfg(any(
     all(feature = "web", feature = "native"),
     not(any(feature = "web", feature = "native"))
@@ -74,8 +76,10 @@ pub mod ext {
     pub use scale_encode;
     pub use scale_value;
     #[cfg(feature = "substrate-compat")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "substrate-compat")))]
     pub use sp_core;
     #[cfg(feature = "substrate-compat")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "substrate-compat")))]
     pub use sp_runtime;
 }
 

subxt/src/tx/mod.rs

@@ -17,6 +17,7 @@ mod tx_progress;
 // The PairSigner impl currently relies on Substrate bits and pieces, so make it an optional
 // feature if we want to avoid needing sp_core and sp_runtime.
 #[cfg(feature = "substrate-compat")]
+#[cfg_attr(docsrs, doc(cfg(feature = "substrate-compat")))]
 pub use self::signer::PairSigner;
 
 pub use self::{

subxt/src/tx/signer.rs

@@ -25,6 +25,7 @@ pub trait Signer<T: Config> {
 }
 
 #[cfg(feature = "substrate-compat")]
+#[cfg_attr(docsrs, doc(cfg(feature = "substrate-compat")))]
 pub use pair_signer::PairSigner;
 
 // A signer suitable for substrate based chains. This provides compatibility with Substrate