New ./scripts/combined-haddock.sh

.github/workflows/combined-haddock.yml

@@ -21,13 +21,13 @@ jobs:
 
       - name: Build Haddock
         run: | 
-          nix develop --accept-flake-config --command bash ./scripts/combined-haddock.sh
+          nix develop --accept-flake-config --command bash ./scripts/combined-haddock.sh haddock all
 
       - name: Deploy Haddock
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           # This folder is generated in the step above
-          folder: combined_haddock_dst
+          folder: haddock
           target-folder: haddock/${{ github.ref_name }}
-          # combined_haddock_dst is ~400MB and keeping the entire history is unnecessary.
+          # haddock is ~400MB and keeping the entire history is unnecessary.
           single-commit: true

.gitignore

@@ -35,6 +35,7 @@ cabal-dev
 cabal.sandbox.config
 cabal.config
 cabal.project.local
+cabal.project.freeze
 
 # Stack
 .stack-work
@@ -99,7 +100,8 @@ node.sock
 .pre-commit-config.yaml
 secrets/*/.gpg-id
 ghcid.txt
-combined_haddock*
+haddock
+linkchecker-out.txt
 plutus-pab/test-node/testnet/db
 plutus-pab/test-node/alonzo-purple/db
 *.actual.json

nix/project.nix

@@ -15,7 +15,7 @@ let
       src = ../.;
 
       shell = {
-        withHoogle = false;
+        withHoogle = true;
         # We would expect R to be pulled in automatically as it's a dependency of
         # plutus-core, but it appears it is not, so we need to be explicit about
         # the dependency on R here. Adding it as a buildInput will ensure it's
@@ -80,16 +80,6 @@ let
         # Common 
         {
           packages = {
-            # Packages we just don't want docs for
-            plutus-benchmark.doHaddock = false;
-
-            # FIXME: Haddock mysteriously gives a spurious missing-home-modules warning
-            plutus-tx-plugin.doHaddock = false;
-
-            # Something goes wrong with the custom setup
-            # https://github.com/input-output-hk/haskell.nix/issues/2019
-            prettyprinter-configurable.doHaddock = false;
-
             # In this case we can just propagate the native dependencies for the build of
             # the test executable, which are actually set up right (we have a
             # build-tool-depends on the executable we need)

nix/shell.nix

@@ -47,6 +47,7 @@ in
     pkgs.gawk
     pkgs.scriv
     pkgs.fswatch
+    pkgs.linkchecker
 
     # Needed to make building things work, not for commands
     pkgs.zlib