Fixed haddock combined

IntersectMBO · zeme-wana · Jun 19, 2024 · Jun 12, 2024 · Jun 13, 2024 · Jun 17, 2024
commit d694f8f5e1a2821c2cb1932554a09ba8a2d904ce
diff --git a/.gitignore b/.gitignore
@@ -99,7 +99,7 @@ node.sock
 .pre-commit-config.yaml
 secrets/*/.gpg-id
 ghcid.txt
-combined_haddock*
+haddocks
 plutus-pab/test-node/testnet/db
 plutus-pab/test-node/alonzo-purple/db
 *.actual.json

diff --git a/cabal.project.freeze b/cabal.project.freeze
@@ -0,0 +1,263 @@
+active-repositories: hackage.haskell.org:merge, cardano-haskell-packages:merge
+constraints: any.Cabal ==3.10.3.0,
+             any.Cabal-syntax ==3.10.3.0,
+             any.Glob ==0.10.2,
+             any.HUnit ==1.6.2.0,
+             any.OneTuple ==0.4.1.1,
+             any.Only ==0.1,
+             any.PyF ==0.11.2.1,
+             any.QuickCheck ==2.14.3,
+             any.StateVar ==1.2.2,
+             any.Stream ==0.4.7.2,
+             any.adjunctions ==4.4.2,
+             any.aeson ==2.2.1.0,
+             any.aeson-pretty ==0.8.10,
+             any.algebraic-graphs ==0.7,
+             any.ansi-terminal ==1.0,
+             any.ansi-terminal-types ==0.11.5,
+             any.ansi-wl-pprint ==1.0.2,
+             any.array ==0.5.6.0,
+             any.assoc ==1.1,
+             any.async ==2.2.5,
+             any.attoparsec ==0.14.4,
+             any.barbies ==2.0.5.0,
+             any.base ==4.18.2.1,
+             any.base-compat ==0.13.1,
+             any.base-compat-batteries ==0.13.1,
+             any.base-orphans ==0.9.1,
+             any.base16-bytestring ==1.0.2.0,
+             any.base64-bytestring ==1.2.1.0,
+             any.basement ==0.0.16,
+             any.bifunctors ==5.6.1,
+             any.bimap ==0.5.0,
+             any.bin ==0.1.3,
+             any.binary ==0.8.9.1,
+             any.binary-orphans ==1.0.4.1,
+             any.bitvec ==1.1.5.0,
+             any.blaze-builder ==0.4.2.3,
+             any.boring ==0.2.1,
+             any.brick ==2.3.1,
+             any.bytestring ==0.11.5.3,
+             any.bytestring-strict-builder ==0.4.5.7,
+             any.call-stack ==0.4.0,
+             any.cardano-binary ==1.7.1.0,
+             any.cardano-crypto ==1.1.2,
+             any.cardano-crypto-class ==2.1.4.0,
+             any.cardano-strict-containers ==0.1.2.1,
+             any.case-insensitive ==1.2.1.0,
+             any.cassava ==0.5.3.0,
+             any.cborg ==0.2.10.0,
+             any.clock ==0.8.4,
+             any.code-page ==0.2.1,
+             any.colour ==2.3.6,
+             any.comonad ==5.0.8,
+             any.composition-prelude ==3.0.0.2,
+             any.concurrent-output ==1.10.20,
+             any.config-ini ==0.2.7.0,
+             any.constraints ==0.14,
+             any.constraints-extras ==0.4.0.0,
+             any.containers ==0.6.7,
+             any.contravariant ==1.5.5,
+             any.criterion ==1.6.3.0,
+             any.criterion-measurement ==0.2.1.0,
+             any.cryptonite ==0.30,
+             any.data-clist ==0.2,
+             any.data-default-class ==0.1.2.0,
+             any.data-fix ==0.3.2,
+             any.dec ==0.0.5,
+             any.deepseq ==1.4.8.1,
+             any.dense-linear-algebra ==0.1.0.0,
+             any.dependent-map ==0.4.0.0,
+             any.dependent-sum ==0.7.2.0,
+             any.deriving-aeson ==0.2.9,
+             any.deriving-compat ==0.6.5,
+             any.dictionary-sharing ==0.1.0.0,
+             any.directory ==1.3.8.4,
+             any.distributive ==0.6.2.1,
+             any.dlist ==1.0,
+             any.doctest ==0.22.2,
+             any.dom-lt ==0.2.3,
+             any.double-conversion ==2.0.4.2,
+             any.either ==5.0.2,
+             any.erf ==2.0.0.0,
+             any.exceptions ==0.10.7,
+             any.extensible-exceptions ==0.1.1.4,
+             any.extra ==1.7.14,
+             any.filemanip ==0.3.6.3,
+             any.filepath ==1.4.300.1,
+             any.fin ==0.3,
+             any.fingertree ==0.1.5.0,
+             any.flat ==0.6,
+             any.foldl ==1.4.15,
+             any.formatting ==7.2.0,
+             any.foundation ==0.0.30,
+             any.free ==5.2,
+             any.generically ==0.1.1,
+             any.ghc ==9.6.5,
+             any.ghc-bignum ==1.3,
+             any.ghc-boot ==9.6.5,
+             any.ghc-boot-th ==9.6.5,
+             any.ghc-heap ==9.6.5,
+             any.ghc-paths ==0.1.0.12,
+             any.ghc-prim ==0.10.0,
+             any.ghci ==9.6.5,
+             any.half ==0.3.1,
+             any.hashable ==1.4.3.0,
+             any.haskeline ==0.8.2.1,
+             any.haskell-lexer ==1.1.1,
+             any.heapwords ==0.1.0.2,
+             any.hedgehog ==1.4,
+             any.hedgehog-fn ==1.0,
+             any.hex-text ==0.1.0.9,
+             any.hostname ==1.0,
+             any.hpc ==0.6.2.0,
+             any.ieee ==0.7,
+             ieee -big_endian,
+             any.ieee754 ==0.8.0,
+             any.indexed-traversable ==0.1.3,
+             any.indexed-traversable-instances ==0.1.1.2,
+             any.integer-conversion ==0.1.0.1,
+             any.integer-gmp ==1.1,
+             any.integer-logarithms ==1.0.3.1,
+             any.invariant ==0.6.2,
+             any.js-chart ==2.9.4.1,
+             any.kan-extensions ==5.2.5,
+             any.lazy-search ==0.1.3.0,
+             any.lazysmallcheck ==0.6,
+             any.lens ==5.2.3,
+             any.lifted-async ==0.10.2.5,
+             any.lifted-base ==0.2.3.12,
+             any.list-t ==1.0.5.7,
+             any.logict ==0.8.1.0,
+             any.managed ==1.0.10,
+             any.math-functions ==0.3.4.3,
+             any.megaparsec ==9.6.1,
+             any.memory ==0.18.0,
+             any.microlens ==0.4.13.1,
+             any.microlens-mtl ==0.2.0.3,
+             any.microlens-th ==0.4.3.14,
+             any.microstache ==1.0.2.3,
+             any.mmorph ==1.2.0,
+             any.monad-control ==1.0.3.1,
+             any.mono-traversable ==1.0.15.3,
+             any.monoidal-containers ==0.6.4.0,
+             any.mtl ==2.3.1,
+             any.multiset ==0.3.4.3,
+             any.mwc-random ==0.15.0.2,
+             any.network ==3.1.4.0,
+             any.network-uri ==2.6.4.2,
+             any.newtype ==0.2.2.0,
+             any.newtype-generics ==0.6.2,
+             any.nonempty-vector ==0.2.3,
+             any.nothunks ==0.1.5,
+             any.old-locale ==1.0.0.7,
+             any.old-time ==1.1.0.4,
+             any.optional-args ==1.0.2,
+             any.optparse-applicative ==0.18.1.0,
+             any.ordered-containers ==0.2.3,
+             any.parallel ==3.2.2.0,
+             any.parsec ==3.1.16.1,
+             any.parser-combinators ==1.3.0,
+             any.plutus-cert ==0.1.0.0,
+             plutus-core +with-cert +with-inline-r,
+             plutus-tx-plugin -use-ghc-stub,
+             any.pretty ==1.1.3.6,
+             any.pretty-show ==1.10,
+             any.prettyprinter ==1.7.1,
+             any.prettyprinter-ansi-terminal ==1.1.3,
+             any.prettyprinter-compat-ansi-wl-pprint ==1.0.2,
+             any.primitive ==0.8.0.0,
+             any.process ==1.6.19.0,
+             any.profunctors ==5.6.2,
+             any.quickcheck-instances ==0.3.30,
+             any.quickcheck-text ==0.1.2.1,
+             any.quickcheck-transformer ==0.3.1.2,
+             any.ral ==0.2.1,
+             any.random ==1.2.1.1,
+             any.recursion-schemes ==5.2.2.5,
+             any.reflection ==2.1.7,
+             any.regex-base ==0.94.0.2,
+             any.regex-posix ==0.96.0.1,
+             any.resourcet ==1.3.0,
+             any.rts ==1.0.2,
+             any.safe ==0.3.19,
+             any.safe-exceptions ==0.1.7.4,
+             any.scientific ==0.3.7.0,
+             any.semialign ==1.3,
+             any.semigroupoids ==6.0.0.1,
+             any.semigroups ==0.20,
+             any.serialise ==0.2.6.1,
+             any.singletons ==3.0.2,
+             any.singletons-th ==3.2,
+             any.size-based ==0.1.3.2,
+             any.some ==1.0.6,
+             any.split ==0.2.4,
+             any.splitmix ==0.1.0.5,
+             any.statistics ==0.16.2.1,
+             any.stm ==2.5.1.0,
+             any.streaming-commons ==0.2.2.6,
+             any.strict ==0.5,
+             any.syb ==0.7.2.4,
+             any.system-cxx-std-lib ==1.0,
+             any.tagged ==0.8.8,
+             any.tasty ==1.5,
+             any.tasty-discover ==5.0.0,
+             any.tasty-expected-failure ==0.12.3,
+             any.tasty-golden ==2.3.5,
+             any.tasty-hedgehog ==1.4.0.2,
+             any.tasty-hunit ==0.10.1,
+             any.tasty-quickcheck ==0.10.3,
+             any.template-haskell ==2.20.0.0,
+             any.temporary ==1.3,
+             any.terminal-size ==0.3.4,
+             any.terminfo ==0.4.1.6,
+             any.test-framework ==0.8.2.0,
+             any.test-framework-hunit ==0.3.0.2,
+             any.test-framework-quickcheck2 ==0.3.0.5,
+             any.testing-type-modifiers ==0.1.0.1,
+             any.text ==2.0.2,
+             any.text-iso8601 ==0.1,
+             any.text-short ==0.1.5,
+             any.text-zipper ==0.13,
+             any.th-abstraction ==0.6.0.0,
+             any.th-compat ==0.1.4,
+             any.th-desugar ==1.15,
+             any.th-expand-syns ==0.4.11.0,
+             any.th-lift ==0.8.4,
+             any.th-lift-instances ==0.1.20,
+             any.th-orphans ==0.13.14,
+             any.th-reify-many ==0.1.10,
+             any.th-utilities ==0.2.5.0,
+             any.these ==1.2,
+             any.time ==1.12.2,
+             any.time-compat ==1.9.6.1,
+             any.transformers ==0.6.1.0,
+             any.transformers-base ==0.4.6,
+             any.transformers-compat ==0.7.2,
+             any.turtle ==1.6.2,
+             any.type-equality ==1,
+             any.typed-process ==0.2.11.1,
+             any.unbounded-delays ==0.1.1.1,
+             any.uniplate ==1.6.13,
+             any.universe-base ==1.1.3.1,
+             any.unix ==2.8.4.0,
+             any.unix-compat ==0.7.1,
+             any.unliftio-core ==0.2.1.0,
+             any.unordered-containers ==0.2.19.1,
+             any.utf8-string ==1.0.2,
+             any.uuid-types ==1.0.5.1,
+             any.vector ==0.13.1.0,
+             any.vector-algorithms ==0.9.0.1.0.0.0.0.1,
+             any.vector-binary-instances ==0.2.5.2,
+             any.vector-stream ==0.1.0.1,
+             any.vector-th-unbox ==0.2.2,
+             any.void ==0.7.3,
+             any.vty ==6.0,
+             any.vty-crossplatform ==0.2.0.0,
+             any.vty-unix ==0.1.0.0,
+             any.witherable ==0.4.2,
+             any.wl-pprint-annotated ==0.1.0.1,
+             any.word-wrap ==0.5,
+             any.xml ==1.3.14,
+             any.zlib ==0.6.3.0
+index-state: cardano-haskell-packages 2024-01-16T10:58:01Z, hackage.haskell.org 2024-01-08T22:38:30Z
diff --git a/linkchecker-out.txt b/linkchecker-out.txt
@@ -0,0 +1,82 @@
+LinkChecker 10.2.1
+Copyright (C) 2000-2016 Bastian Kleineidam, 2010-unknown LinkChecker Authors
+LinkChecker comes with ABSOLUTELY NO WARRANTY!
+This is free software, and you are welcome to redistribute it under
+certain conditions. Look at the file `LICENSE' within this distribution.
+Read the documentation at https://linkchecker.github.io/linkchecker/
+Write comments and bugs to https://github.com/linkchecker/linkchecker/issues
+
+Start checking at 2024-06-17 19:16:44+002
+
+URL        `Data-Aeson-Types-FromJSON.html'
+Name       `Data.Aeson.Types.FromJSON'
+Parent URL file:///Volumes/Repos/plutus/haddocks/plutus-tx/PlutusTx-Prelude.html, line 3203, col 21
+Real URL   file:///Volumes/Repos/plutus/haddocks/plutus-tx/Data-Aeson-Types-FromJSON.html
+Check time 0.000 seconds
+Result     Error: URLError: <urlopen error [Errno 2] No such file or directory: '/Volumes/Repos/plutus/haddocks/plutus-tx/Data-Aeson-Types-FromJSON.html'>
+
+URL        `Data-Aeson-Types-ToJSON.html'
+Name       `Data.Aeson.Types.ToJSON'
+Parent URL file:///Volumes/Repos/plutus/haddocks/plutus-tx/PlutusTx-Prelude.html, line 3293, col 21
+Real URL   file:///Volumes/Repos/plutus/haddocks/plutus-tx/Data-Aeson-Types-ToJSON.html
+Check time 0.000 seconds
+Result     Error: URLError: <urlopen error [Errno 2] No such file or directory: '/Volumes/Repos/plutus/haddocks/plutus-tx/Data-Aeson-Types-ToJSON.html'>
+
+URL        `Basement-Numerical-Subtractive.html'
+Name       `Basement.Numerical.Subtractive'
+Parent URL file:///Volumes/Repos/plutus/haddocks/plutus-tx/PlutusTx-Prelude.html, line 4347, col 21
+Real URL   file:///Volumes/Repos/plutus/haddocks/plutus-tx/Basement-Numerical-Subtractive.html
+Check time 0.000 seconds
+Result     Error: URLError: <urlopen error [Errno 2] No such file or directory: '/Volumes/Repos/plutus/haddocks/plutus-tx/Basement-Numerical-Subtractive.html'>
+
+URL        `Text-PrettyPrint-Annotated-WL.html'
+Name       `Text.PrettyPrint.Annotated.WL'
+Parent URL file:///Volumes/Repos/plutus/haddocks/plutus-tx/PlutusTx-Prelude.html, line 5761, col 21
+Real URL   file:///Volumes/Repos/plutus/haddocks/plutus-tx/Text-PrettyPrint-Annotated-WL.html
+Check time 0.000 seconds
+Result     Error: URLError: <urlopen error [Errno 2] No such file or directory: '/Volumes/Repos/plutus/haddocks/plutus-tx/Text-PrettyPrint-Annotated-WL.html'>
+
+URL        `https://hackage.haskell.org/package/hashable-1.4.3.0/docs/Data-Hashable-Class.html'
+Name       `Data.Hashable.Class'
+Parent URL file:///Volumes/Repos/plutus/haddocks/plutus-tx/PlutusTx-Prelude.html, line 4663, col 21
+Real URL   https://hackage.haskell.org/package/hashable-1.4.3.0/docs/Data-Hashable-Class.html
+Check time 3.972 seconds
+Size       43B
+Result     Error: 404 Not Found
+
+URL        `Data-Reflection.html'
+Name       `Data.Reflection'
+Parent URL file:///Volumes/Repos/plutus/haddocks/plutus-tx/PlutusTx-Prelude.html, line 6583, col 21
+Real URL   file:///Volumes/Repos/plutus/haddocks/plutus-tx/Data-Reflection.html
+Check time 0.000 seconds
+Result     Error: URLError: <urlopen error [Errno 2] No such file or directory: '/Volumes/Repos/plutus/haddocks/plutus-tx/Data-Reflection.html'>
+
+URL        `https://hackage.haskell.org/package/random-1.2.1.1/docs/System-Random-Internal.html'
+Name       `System.Random.Internal'
+Parent URL file:///Volumes/Repos/plutus/haddocks/plutus-tx/PlutusTx-Prelude.html, line 5635, col 21
+Real URL   https://hackage.haskell.org/package/random-1.2.1.1/docs/System-Random-Internal.html
+Check time 3.601 seconds
+Size       43B
+Result     Error: 404 Not Found
+
+URL        `GHC.html#v:Rational'
+Name       `Rational'
+Parent URL file:///Volumes/Repos/plutus/haddocks/plutus-tx/PlutusTx-Prelude.html, line 10519, col 10
+Real URL   file:///Volumes/Repos/plutus/haddocks/plutus-tx/GHC.html
+Check time 0.000 seconds
+Result     Error: URLError: <urlopen error [Errno 2] No such file or directory: '/Volumes/Repos/plutus/haddocks/plutus-tx/GHC.html'>
+
+URL        `Alonzo.html#v:CostModel'
+Name       `CostModel'
+Parent URL file:///Volumes/Repos/plutus/haddocks/plutus-ledger-api/PlutusLedgerApi-Common-Eval.html, line 2011, col 9
+Real URL   file:///Volumes/Repos/plutus/haddocks/plutus-ledger-api/Alonzo.html
+Check time 0.000 seconds
+Result     Error: URLError: <urlopen error [Errno 2] No such file or directory: '/Volumes/Repos/plutus/haddocks/plutus-ledger-api/Alonzo.html'>
+
+Statistics:
+Downloaded: 98.0MB.
+Content types: 1 image, 1254 text, 0 video, 0 audio, 13 application, 0 mail and 435 other.
+URL lengths: min=36, max=553, avg=86.
+
+That's it. 1703 links in 1731 URLs checked. 0 warnings found (2 ignored or duplicates not printed). 9 errors found.
+Stopped checking at 2024-06-17 19:20:09+002 (3 minutes, 24 seconds)
diff --git a/nix/shell.nix b/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