From 44be1defb3b919b24e920d65b9620b29aad2cf3a Mon Sep 17 00:00:00 2001
From: Bruce Mitchener <bruce.mitchener@gmail.com>
Date: Sat, 16 Nov 2024 14:56:47 +0700
Subject: [PATCH] docs / ci: Add CI for docs.

---
 .github/workflows/check-docs.yml | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 .github/workflows/check-docs.yml

diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml
new file mode 100644
index 00000000..93584b80
--- /dev/null
+++ b/.github/workflows/check-docs.yml
@@ -0,0 +1,23 @@
+name: Check documentation
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  CARGO_TERM_COLOR: always
+  RUSTDOCFLAGS: '--cfg docsrs -D warnings'
+
+jobs:
+  # We test documentation using nightly to match docs.rs.
+  check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: Swatinem/rust-cache@v2
+    - name: Install nightly Rust
+      run: rustup default nightly
+    - name: Check docs
+      run: cargo doc --workspace --no-deps --document-private-items