haskell / haskell/cabal

Separate haddock doc URI from documentation path

Open
#2,028 3 comments 0 reactions 0 assignees View on GitHub
Cabal: other type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

Hi,

I'd like to be able to expose haddock documentation over HTTP so that, for instance, I can develop on one machine and browse the docs for the library I'm working on from another, or so that we can keep a copy of the docs for a particular build.

This _almost_ works already, except that the `haddock-html` field in the package database always points to the filesystem path at which the docs are installed (as set by `--htmldir`), which means that cross-refs between packages don't work when visited over HTTP.

Would it be reasonable to add another setting that allows the `haddock-html` field to be set to something other than a filesystem path? I can attempt the changes myself if you think this is a good idea to try.

Many thanks,

David

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.