haskell / haskell/cabal

`cabal haddock-project` does not generate an index file for all the transitive deps

Open
#10,968 2 comments 0 reactions 0 assignees View on GitHub
cabal-install: cmd/haddock-project
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

it seems like it generates an index.html thats only the haddocks for your local code, and presumably transitive deps via haddocks.

how would i generate a one true index file? I'd like to keep linkages local for offline hackery, i think i had some scripts for something like this years ago, but this seems like a decent command to have that power

(to be clear, i like how the `./haddock` folder has local docs for all the deps afaict)

Contributor guide

Open the contributing guide

Research direction

Start by reproducing `cabal haddock-project` and inspecting the generated `./haddock` directory, especially its `index.html`. Trace how Haddock pages for local code and transitive dependencies are gathered, then define completion as producing one offline index linking all generated documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.