commercialhaskell / commercialhaskell/stack

Functionality for generating documentation which has links to dependency documentation in Stackage/Hackage

Open
#5,255 0 comments 1 reaction 0 assignees View on GitHub
type: enhancement
Dominant language
Haskell
Stars
4.1k
Forks
850
Avg merge
10h 37m
Merged PRs (30d)
4

Description

My use case is:

- I have a project with a couple of packages.
- I would like to generate documentation for these packages suitable for uploading to github pages (or my own server, whatever)
- Generating documentation with `stack haddock --haddock-hyperlink-source` is great, however it generates local documentation for all dependencies, this would ordinarily be useful, but for publishing it would be nice if any documentation links pointing to packages not in my current project would point to Stackage/Hackage if the package version is available there.

There is an existing project [standalone-haddock](https://documentup.com/ktvoelker/standalone-haddock) which claims to do exactly this, but it's bitrotted a little.

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.