Add docrs CI

.github/workflows/doc.yml

@@ -0,0 +1,51 @@
+name: doc 
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - 'README.md'
+      - 'COPYRIGHT'
+      - 'LICENSE*'
+      - '**.md'
+      - '**.txt'
+      - 'art'
+  pull_request:
+    paths-ignore:
+      - 'README.md'
+      - 'COPYRIGHT'
+      - 'LICENSE*'
+      - '**.md'
+      - '**.txt'
+      - 'art'
+  workflow_dispatch:
+
+env:
+  nightly: nightly
+
+jobs:
+  docs:
+    name: docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Cache cargo build and registry
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ~/.cargo/git
+            target
+          key: ubuntu-latest-docs-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ubuntu-latest-docs-
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ env.nightly }}
+          override: true
+      - name: "doc --lib --all-features"
+        run: cargo doc --lib --no-deps --all-features
+        env:
+          RUSTFLAGS: --cfg docsrs
+          RUSTDOCFLAGS: --cfg docsrs -Dwarnings

core/src/lib.rs

@@ -77,10 +77,10 @@ pub mod tests {
     pub use crate::base::tests::*;
   }
 
-  /// Add `test` prefix to the predefined unit test fn with a given [`Runtime`]
   #[cfg(any(feature = "test", test))]
   #[cfg_attr(docsrs, doc(cfg(any(feature = "test", test))))]
   #[macro_export]
+  #[doc(hidden)]
   macro_rules! unit_tests {
     ($runtime:ty => $run:ident($($fn:ident), +$(,)?)) => {
       $(
@@ -94,10 +94,10 @@ pub mod tests {
     };
   }
 
-  /// Add `test` prefix to the predefined unit test fn with a given [`Runtime`]
   #[cfg(any(feature = "test", test))]
   #[cfg_attr(docsrs, doc(cfg(any(feature = "test", test))))]
   #[macro_export]
+  #[doc(hidden)]
   macro_rules! unit_tests_with_expr {
     ($run:ident($(
       $(#[$outer:meta])*

memberlist/src/lib.rs

@@ -34,17 +34,17 @@ pub mod quic {
   pub use memberlist_quic::*;
 }
 
-/// [`Memberlist`](memberlist_core::Memberlist) for `tokio` runtime.
+/// [`Memberlist`] for `tokio` runtime.
 #[cfg(feature = "tokio")]
 #[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
 pub mod tokio;
 
-/// [`Memberlist`](memberlist_core::Memberlist) for `async-std` runtime.
+/// [`Memberlist`] for `async-std` runtime.
 #[cfg(feature = "async-std")]
 #[cfg_attr(docsrs, doc(cfg(feature = "async-std")))]
 pub mod async_std;
 
-/// [`Memberlist`](memberlist_core::Memberlist) for `smol` runtime.
+/// [`Memberlist`] for `smol` runtime.
 #[cfg(feature = "smol")]
 #[cfg_attr(docsrs, doc(cfg(feature = "smol")))]
 pub mod smol;

transports/net/src/error.rs

@@ -3,7 +3,7 @@ use std::net::{IpAddr, SocketAddr};
 use memberlist_core::transport::{TransportError, Wire};
 use nodecraft::resolver::AddressResolver;
 
-/// Errors that can occur when using [`NetTransport`].
+/// Errors that can occur when using [`NetTransport`](super::NetTransport).
 #[derive(thiserror::Error)]
 pub enum NetTransportError<A: AddressResolver, W: Wire> {
   /// Connection error.

transports/net/src/tests.rs

@@ -33,7 +33,7 @@ use crate::compressor::Compressor;
 
 pub use super::promised_processor::listener_backoff;
 
-/// Unit test for handling [`Ping`] message
+/// Unit test for handling `Ping` message
 pub mod handle_ping;
 
 /// Unit test for handling compound ping message

types/src/message.rs

@@ -122,7 +122,7 @@ impl<I, A> Message<I, A> {
   ///
   /// This constant specifies a range of tag values that are reserved for internal use
   /// by the [`Message`] enum variants. When implementing custom
-  /// with [`Wire`](crate::transport::Wire) or [`Transport`](crate::transport::Transport),
+  /// with [`Wire`] or [`Transport`],
   /// it is important to ensure that any custom header added to the message bytes does not
   /// start with a tag value within this reserved range.
   ///
@@ -134,6 +134,9 @@ impl<I, A> Message<I, A> {
   /// Adhering to this constraint is crucial for ensuring that custom messages
   /// are correctly distinguishable from the standard messages defined by the `Message` enum.
   /// Failing to do so may result in incorrect message parsing and handling.
+  ///
+  /// [`Wire`]: https://docs.rs/memberlist/latest/memberlist/transport/trait.Wire.html
+  /// [`Transport`]: https://docs.rs/memberlist/latest/memberlist/transport/trait.Transport.html
   pub const RESERVED_TAG_RANGE: std::ops::RangeInclusive<u8> = (0..=128);
 
   /// Returns the tag of the compound message type for encoding/decoding.

types/src/server.rs

@@ -28,7 +28,7 @@ pub enum State {
 }
 
 impl State {
-  /// Returns the [`NodeStateState`] as a `&'static str`.
+  /// Returns the [`State`] as a `&'static str`.
   pub const fn as_str(&self) -> &'static str {
     match self {
       Self::Alive => "alive",