Merge pull request #40 from robertknight/lib-cli-doc-conflict

Disable doc generation for ocrs CLI tool
robertknight · Mar 10, 2024 · f8112f5 · f8112f5
2 parents 521aafe + 62bdc68
commit f8112f5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -34,5 +34,7 @@ jobs:
       run: |
         make checkformatting
         make lint
+    - name: Docs
+      run: make doc
     - name: E2E Test
       run: make test-e2e
diff --git a/Makefile b/Makefile
@@ -14,6 +14,10 @@ check: checkformatting test lint
 checkformatting:
 	cargo fmt --check
 
+.PHONY: docs
+doc:
+	cargo doc
+
 .PHONY: lint
 lint:
 	cargo clippy --workspace

diff --git a/ocrs-cli/Cargo.toml b/ocrs-cli/Cargo.toml
@@ -25,3 +25,7 @@ anyhow = "1.0.79"
 [[bin]]
 name = "ocrs"
 path = "src/main.rs"
+
+# Disable documentation for ocrs binary to avoid a filename conflict in
+# `target/doc/` with docs for the ocrs library crate.
+doc = false