docs: Add [package.metadata.docs.rs] and doc_auto_cfg (#350)

* docs: Add [package.metadata.docs.rs] and doc_auto_cfg

#### Problem

A few packages aren't configured properly for the docs.rs build to
handle features.

#### Summary of changes

Add `[package.metadata.docs.rs]` to Cargo.toml files that don't have it,
and `#![cfg_attr(docsrs, feature(doc_auto_cfg))]` to lib.rs files that
don't have it either.

Also, add a CI step to make sure that all Cargo.toml and lib.rs files
have the proper annotations.

* Fix shellcheck error

* Improve regex

Author: joncinque

.github/workflows/main.yml

@@ -36,6 +36,9 @@ jobs:
       - name: Run ShellCheck
         run: ./scripts/check-shell.sh
 
+      - name: Check doc features
+        run: ./scripts/check-doc-features.sh
+
   check-crates:
     name: Check crate ownership
     runs-on: ubuntu-latest

Cargo.toml

@@ -118,6 +118,11 @@ check-cfg = [
     'cfg(feature, values("frozen-abi", "no-entrypoint"))',
 ]
 
+[workspace.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+all-features = true
+rustdoc-args = ["--cfg=docsrs"]
+
 [workspace.metadata.release]
 pre-release-commit-message = "Publish {{crate_name}} v{{version}}"
 tag-message = "Publish {{crate_name}} v{{version}}"

address/Cargo.toml

@@ -10,6 +10,11 @@ homepage = { workspace = true }
 license = { workspace = true }
 edition = { workspace = true }
 
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+all-features = true
+rustdoc-args = ["--cfg=docsrs"]
+
 [features]
 atomic = ["dep:solana-atomic-u64"]
 borsh = ["dep:borsh", "std"]

atomic-u64/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 pub use implementation::AtomicU64;
 
 #[cfg(target_pointer_width = "64")]

big-mod-exp/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #[repr(C)]
 pub struct BigModExpParams {
     pub base: *const u8,

bincode/src/lib.rs

@@ -1,6 +1,7 @@
 //! Contains a single utility function for deserializing from [bincode].
 //!
 //! [bincode]: https://docs.rs/bincode
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 
 use {bincode::config::Options, solana_instruction_error::InstructionError};
 

bls-signatures/Cargo.toml

@@ -10,6 +10,11 @@ homepage = { workspace = true }
 license = { workspace = true }
 edition = { workspace = true }
 
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+all-features = true
+rustdoc-args = ["--cfg=docsrs"]
+
 [lib]
 crate-type = ["rlib"]
 

bls-signatures/src/lib.rs

@@ -1,4 +1,5 @@
 #![no_std]
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![cfg_attr(feature = "frozen-abi", feature(min_specialization))]
 
 extern crate alloc;

bn254/Cargo.toml

@@ -10,6 +10,11 @@ license = { workspace = true }
 edition = { workspace = true }
 include = ["src/**/*"]
 
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+all-features = true
+rustdoc-args = ["--cfg=docsrs"]
+
 [dependencies]
 bytemuck = { workspace = true, features = ["derive"] }
 thiserror = { workspace = true }

bn254/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 pub(crate) mod addition;
 pub mod compression;
 pub(crate) mod multiplication;