Add doc generator to the CI, add WASM target builder

Author: karalabe

.github/workflows/ci.yml

@@ -10,8 +10,13 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+  test:
+    name: Test on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macOS-latest ]
+
     steps:
       - uses: actions/checkout@v5
 
@@ -27,6 +32,26 @@ jobs:
       - name: Test with all features
         run: cargo test --all-features
 
+  build:
+    name: Build for target ${{ matrix.target }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target:
+          - wasm32-wasip1
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Add target
+        run: rustup target add ${{ matrix.target }}
+
+      - name: Fetch dependencies
+        run: cargo fetch
+
+      - name: Build for target
+        run: cargo build --all-features --target ${{ matrix.target }}
+
   format:
     runs-on: ubuntu-latest
     steps:
@@ -38,3 +63,9 @@ jobs:
     steps:
       - uses: actions/checkout@v5
       - run: cargo clippy --all-features -- -D warnings
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - run: cargo doc --all-features --no-deps

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "darkbio-crypto"
-version = "0.6.4"
+version = "0.6.5"
 authors = ["Péter Szilágyi <peter@dark.bio>"]
 description = "Cryptography primitives and wrappers"
 repository = "https://github.com/dark-bio/crypto-rs"
@@ -10,6 +10,7 @@ edition = "2024"
 
 [package.metadata.docs.rs]
 all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
 default = []

Cargo.toml

@@ -243,7 +243,7 @@ impl Context {
     /// The method returns an encapsulated session key (which may be used for stream
     /// communication but this method does not need it) concatenated with the cipher-
     /// text with the encrypted data and authenticity proofs. To open it on the other
-    /// side needs transmitting the <concat-session-key-ciphertext> and <msg_to_auth>.
+    /// side needs transmitting the `concat-session-key-ciphertext` and `msg_to_auth`.
     ///
     /// This method (and open) requires the public keys of both parties to be pre-
     /// shared. It is not suitable for a key exchange protocol!

src/hpke.rs

@@ -67,7 +67,7 @@ impl PublicKey {
     ///
     /// Note, this method is only for testing, most of the contained data will be
     /// junk; and also the produces certificate is not fully spec-adhering:
-    ///   https://github.com/indygreg/cryptography-rs/issues/26
+    ///   <https://github.com/indygreg/cryptography-rs/issues/26>
     pub fn to_test_cert_pem(&self, start: u64, until: u64, signer: eddsa::SecretKey) -> String {
         self.to_test_cert(start, until, signer)
             .encode_pem()
@@ -78,7 +78,7 @@ impl PublicKey {
     ///
     /// Note, this method is only for testing, most of the contained data will be
     /// junk; and also the produces certificate is not fully spec-adhering:
-    ///   https://github.com/indygreg/cryptography-rs/issues/26
+    ///   <https://github.com/indygreg/cryptography-rs/issues/26>
     pub fn to_test_cert_der(&self, start: u64, until: u64, signer: eddsa::SecretKey) -> Vec<u8> {
         self.to_test_cert(start, until, signer)
             .encode_der()
@@ -89,7 +89,7 @@ impl PublicKey {
     ///
     /// Note, this method is only for testing, most of the contained data will be
     /// junk; and also the produced certificate is not fully spec-adhering:
-    ///   https://github.com/indygreg/cryptography-rs/issues/26
+    ///   <https://github.com/indygreg/cryptography-rs/issues/26>
     pub fn to_test_cert(
         &self,
         start: u64,

src/hpke_cert.rs

@@ -4,7 +4,10 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Pull in the README as the package doc
 #![doc = include_str!("../README.md")]
+// Enable the experimental doc_cfg feature
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 #[cfg(feature = "cbor")]
 pub mod cbor;

src/lib.rs

@@ -21,7 +21,7 @@
 // THE SOFTWARE.
 
 //! I/O helper structs for age file encryption and decryption.
-//! https://github.com/str4d/rage/blob/main/age/src/primitives/stream.rs
+//! <https://github.com/str4d/rage/blob/main/age/src/primitives/stream.rs>
 
 #![allow(clippy::all)]