haddock.git/haddock-api/src/Haddock/Backends, branch ghc-9.4

Merge remote-tracking branch 'upstream/ghc-9.4' into ghc-9.4

2022-07-21T02:27:19+00:00

Preparing for publication.

2022-07-18T08:09:23+00:00

- license - cabal - readme

a hole in fieldocc

2022-07-18T08:09:23+00:00

removing hackage url for ids

2022-07-18T08:09:23+00:00

Adding hackage url to top level decl properties

2022-07-18T08:09:23+00:00

Adding org backend.

2022-07-18T08:08:00+00:00

Fix #783 Don't show button if --quickjump not present

2022-06-12T20:57:19+00:00

Render module tree per package in the content page (#1492)

2022-06-07T06:09:40+00:00

* Render module tree per package in the content page When rendering content page for multiple packages it is useful to split the module tree per package. Package names in this patch are inferred from haddock's interface file names. * Write PackageInfo into interface file To keep interface file format backward compatible, instead of using `Binary` instance for `InterfaceFile` we introduce functions to serialise and deserialise, which depends on the interface file version.

Check if doc-index.json exists before reading it (#1488)

2022-05-24T06:29:59+00:00

Fix hyperlinks to external items and modules (#1482)

2022-05-07T15:42:08+00:00

Fixes #1481. There were two bugs in this: * We were assuming that we were always getting a relative path to the module in question, while Nix gives us file:// URLs sometimes. This change checks for those and stops prepending `..` to them. * We were not linking to the file under the module. This seems to have been a regression introduced by #977. That is, the URLs were going to something like file:///nix/store/3bwbsy0llxxn1pixx3ll02alln56ivxy-ghc-9.0.2-doc/share/doc/ghc/html/libraries/base-4.15.1.0/src which does not have the appropriate HTML file or fragment for the item in question at the end. There is a remaining instance of the latter bug, but not in the hyperlinker: the source links to items reexported from other modules are also not including the correct file name. e.g. the reexport of Entity in esqueleto, from persistent. NOTE: This needs to get tested with relative-path located modules. It seems correct for Nix based on my testing. Testing strategy: ``` nix-shell '' --pure -A haskell.packages.ghc922.aeson mkdir /tmp/aesonbuild && cd /tmp/aesonbuild export out=/tmp/aesonbuild/out genericBuild ln -sf $HOME/co/haddock/haddock-api/resources . ./Setup haddock --with-haddock=$HOME/path/to/haddock/exec --hyperlink-source ```