ci: add documentation generation job (modelcontextprotocol#59)

* ci: add documentation generation job

1. add doc ci in workflow
2. remove the readme in rmcp crate

Signed-off-by: jokemanfire <[email protected]>

* docs: fix doc test in README.md

1) fix doc test in readme
2) fix some fmt

Signed-off-by: jokemanfire <[email protected]>

---------

Signed-off-by: jokemanfire <[email protected]>

Author: jokemanfire

.github/workflows/ci.yml

@@ -90,6 +90,23 @@ jobs:
       - name: Run tests
         run: cargo test --all-features
 
+  doc:
+    name: Generate Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+
+      - name: Generate documentation
+        run: |
+          cargo doc --no-deps -p rmcp -p rmcp-macros
+        env:
+          RUSTDOCFLAGS: -Dwarnings
+
   release:
     name: Release crates
     runs-on: ubuntu-latest

README.md

@@ -24,9 +24,13 @@ Start a client in one line:
 use rmcp::{ServiceExt, transport::TokioChildProcess};
 use tokio::process::Command;
 
-let client = ().serve(
-    TokioChildProcess::new(Command::new("npx").arg("-y").arg("@modelcontextprotocol/server-everything"))?
-).await?;
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let client = ().serve(
+        TokioChildProcess::new(Command::new("npx").arg("-y").arg("@modelcontextprotocol/server-everything"))?
+    ).await?;
+    Ok(())
+}
 ```
 
 #### 1. Build a transport

crates/rmcp/README.md

@@ -1,4 +1,3 @@
-#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]
 mod error;
 pub use error::Error;