doc: add haddock command

change-metrics · Jan 6, 2024 · b9624a5 · b9624a5
1 parent cea5db3
commit b9624a5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git 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
@@ -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