Skip to content

'cabal haddock --hyperlink-source' should use haddock '--hyperlinked-source' when available #4613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
23Skidoo opened this issue Jul 20, 2017 · 0 comments
Closed

'cabal haddock --hyperlink-source' should use haddock '--hyperlinked-source' when available #4613

23Skidoo opened this issue Jul 20, 2017 · 0 comments
Assignees
@23Skidoo
Labels
Cabal: cmd/haddock type: enhancement
Milestone
2.0.2

Comments

@23Skidoo
Copy link
Member

Saw this on Reddit today: https://www.reddit.com/r/haskell/comments/6o4rnb/psa_regarding_cabal_haddock/

PSA regarding cabal haddock
cabal haddock --haddock-option="--hyperlinked-source" is different from cabal haddock --hyperlink-source.
The former is how you create the nice haddocks that have links on every identifier in the highlighted source. The latter is how you get the old haddocks that just have hscoloured source pages.

I think we should update cabal haddock --hyperlink-source to make it use haddock --hyperlinked-source instead of hscolour when the version of Haddock is sufficiently new.
@23Skidoo 23Skidoo self-assigned this Jul 20, 2017
@23Skidoo 23Skidoo added this to the 2.0.1 milestone Jul 20, 2017
@23Skidoo 23Skidoo modified the milestones: 2.0.1, 2.0.2 Sep 19, 2017
harpocrates added a commit to harpocrates/cabal that referenced this issue Feb 12, 2018
@harpocrates
Use Haddock's hyperlinker instead of HsColour
e96bf2b 
Fixes haskell#4613. If a new enough version of Haddock is being used,
`--hyperlink-source` will run via Haddock's `--hyperlinked-source`
instead of going through HsColour.
@harpocrates harpocrates mentioned this issue Feb 12, 2018
Merged
4 tasks
@gbaz gbaz mentioned this issue Feb 18, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@23Skidoo 23Skidoo

Labels
Cabal: cmd/haddock type: enhancement
Projects
None yet
Milestone
2.0.2
Development

No branches or pull requests
1 participant
@23Skidoo