haskell / haskell/cabal

Haddock documentation not linked into user index

Open
#1,316 7 comments 0 reactions 0 assignees View on GitHub
priority: low type: bug
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

Hi, I am using following script to wrap `cabal install` to avoid installing to public space. The building seemed fine. And the documents were installed into ".cabal/share/doc/x86_64-linux-ghc-7.6.3/". But they are not linked into ".cabal/share/doc/index.html". What else should I set?
`ghc-pkg init dist/db && cabal install --prefix=`pwd`/dist --datadir=$HOME/.cabal/share --package-db=`pwd`/dist/db`

Contributor guide

Open the contributing guide

Research direction

Reproduce the report with the command in the issue, then inspect the generated files under .cabal/share/doc/x86_64-linux-ghc-7.6.3/ and .cabal/share/doc/index.html. Trace how cabal install handles Haddock output and the user index; done means installed documentation is linked from index.html for this local prefix and package database setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
build-system, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.