From b9624a54ab1e8466cc77767a0abcee89b210a356 Mon Sep 17 00:00:00 2001
From: Tristan Cacqueray <tdecacqu@redhat.com>
Date: Sat, 6 Jan 2024 12:38:48 -0500
Subject: [PATCH] doc: add haddock command

---
 CONTRIBUTING.md | 8 ++++++++
 Justfile        | 4 ++++
 2 files changed, 12 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9708c39d8..2190396a8 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -94,6 +94,14 @@ For instance running a crawler:
 nix run . -- lentille github-projects --url https://api.github.com/graphql --token <a-valid-token> --organization change-metrics
 ```
 
+### Build the documentation
+
+Build and read the code documentation:
+
+```
+just docs
+```
+
 ## nix-develop
 
 The nix develop shell provides development tooling such as:
diff --git a/Justfile b/Justfile
index 52a17c807..a773eee70 100644
--- a/Justfile
+++ b/Justfile
@@ -46,6 +46,10 @@ test pattern:
 ghcid:
     nix develop --command ghcid
 
+# Build and open the documentation
+docs:
+    nix develop --command cabal haddock --open
+
 # Start hoogle with local monocle documentation
 hoogle-monocle:
     nix develop .#hoogle-monocle --command hoogle server -p 8081 --local --haskell