[Docs] Add rustdoc checks to CI and tests to pre-commit (#83)

.github/workflows/ci.yml

@@ -100,3 +100,17 @@ jobs:
       - name: Run clippy (local)
         run: cargo clippy --verbose --bins --lib --examples --all-features
         if: ${{ env.ACT }} # only run during local actions testing
+  doc:
+    name: "Check rustdoc"
+    runs-on: ubuntu-latest
+    needs: [ "build_first" ]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: "cargo-deps"
+          cache-targets: false
+      - name: "Run cargo doc"
+        run: cargo doc
+        env:
+          RUSTDOCFLAGS: "-D warnings"

.pre-commit-config.yaml

@@ -21,6 +21,12 @@ repos:
         files: '[.]rs$'
         pass_filenames: false
         entry: cargo build --all-features --lib --bins --examples
+      - id: test
+        name: Check tests pass
+        language: system
+        files: '[.]rs$'
+        pass_filenames: false
+        entry: cargo test
       - id: format
         name: Check rustfmt
         language: system
@@ -33,6 +39,12 @@ repos:
         files: '[.]rs$'
         pass_filenames: false
         entry: rustup run --install 1.60 cargo build
+      - id: docs
+        name: Check rustdoc compiles
+        language: system
+        files: '[.]rs$'
+        pass_filenames: false
+        entry: env RUSTDOCFLAGS="-D warnings" cargo doc
       - id: actions
         name: Check actions work
         language: system