haskell / haskell/cabal

cabal new-haddock and project index

Open
#5,268 11 comments 0 reactions 0 assignees View on GitHub
cabal-install: v2-build system Cabal: cmd/haddock meta: easy newcomer newcomer: 4-small-feature re: installed-package-info type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

Hello,

I can't seem to find a way to tell cabal new-haddock to put the top-level index for a package in an index common for my project (e.g., something like haddock's `use-index` option). Is this possible? If not, this would be a handy feature to have.

Contributor guide

Open the contributing guide

Research direction

Start by investigating the cabal new-haddock entry point and how it handles Haddock's use-index option. Determine whether a project-level common index can be configured; done means documenting the existing behavior or supporting the requested shared top-level index for project packages.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.