add docs-rs tests

KenDJohnson · Jun 18, 2024 · 68ddd8d · 68ddd8d
1 parent 43a31b3
commit 68ddd8d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -36,6 +36,19 @@ jobs:
       - uses: actions-rs/audit-check@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+  doc:
+    name: Documentation
+    runs-on: ubuntu-latest
+    env:
+      RUSTDOCFLAGS: -Dwarnings
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+      - uses: dtolnay/install
+        with:
+          crate: cargo-docs-rs
+      - run: cargo docs-rs
+
   check:
     name: check and run tests
     runs-on: ubuntu-latest

diff --git a/Cargo.toml b/Cargo.toml
@@ -7,6 +7,7 @@ license = "MIT OR Apache-2.0"
 keywords = ["cpe"]
 description = "CPE 2.2 and 2.3 handling in Rust"
 repository = "https://github.com/johnso51/cpe-rs"
+documentation = "https://docs.rs/cpe"
 rust-version = "1.65"
 
 [dependencies]