Skip to content

Include standalone haddock derivation for a project #737

Open
@michaelpj

Description

@michaelpj

This would require a bit of hacking, but I think probably worth it (see e.g. #735).

We can copy my hack in https://github.com/input-output-hk/plutus/blob/master/nix/haddock-combine.nix, however I think we should:

  • Rewrite it in a better language (maybe just Python)
  • Deal with the remaining store references (optionally?)

For the latter one, I can see two approaches:

  1. Copy any store paths which are referenced in URLs into a "fake store" directory in the bundle, and rewrite any paths to point to that directory. We'd have to do this repeatedly, and it would use up lots of space, but if we want it to be standalone I think it's what we need to do.
  2. Point them to Hackage where possible (maybe fall back to 1. if we can't find the package version).

Related issues so I remember:

Support in cabal: haskell/cabal#5383
Support in haddock: haskell/haddock#1086, haskell/haddock#1126
Existing standalone-haddock tool is outdated: ktvoelker/standalone-haddock#30

Metadata

Metadata

Assignees

No one assigned

    Labels

    preservedKeep stale bot away

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions