Documentation and Source links for local dependencies

[eirikm]

Hi, today I get a Documentation and a Source link when hovering functions in packages published on hackage.

Is it possible to get these links for functions in private libraries?

I have tried stack haddock which generates the html documentation and source needed but it doesn't look like the haskell-plugin is aware of this.

[jneira]

Hi, thanks for opening the issue, to get docs on hover it is needed to build them with the -haddock ghc flag as described here: https://github.com/haskell/haskell-language-server#features

[eirikm]

By adding the flag I get the haddock documentation in the popup, but not the links to Documentation and Source.

Mac OS 10.15.7
VSCode 1.56.2
haskell-language-server-1.1.0-darwin-8.10.4
haskell.haskell v1.4.0
stack 2.7.1 x86_64 hpack-0.34.4

[eirikm]

https://github.com/eirikm/hls-testcase/tree/reproduce_1866_take_1

Hover on putStrLn is displayed fine with both haddock and Documentation-link

Hover on LocalLib.someFunc displays haddock but not Documentation- and Source-link (I guess this is intentionally)

Hover on PackagesLib.someFunc displays everything fine!

Hover on ExtraDepsLib.someFunc is missing haddock documentation.

[georgefst]

Just to check this is consistent with #208, I assume you've enabled --enable-documentation?

Also this should probably be renamed to "Documentation and Source links for local dependencies" or similar, so it isn't conflated with #208.

[georgefst]

Just to check this is consistent with #208, I assume you've enabled --enable-documentation?

Ah, I see you're using Stack. Is there a Stack equivalent? Or is the functionality enabled by default?

[eirikm]

I thought that this would do the trick:
https://github.com/eirikm/hls-testcase/blob/2f276e4a4f8a2fac6b41e8abf8a0aca182868040/app/stack.yaml#L70

but apparently it doesn't in my case.

[jneira]

I thought that this would do the trick: https://github.com/eirikm/hls-testcase/blob/2f276e4a4f8a2fac6b41e8abf8a0aca182868040/app/stack.yaml#L70

but apparently it doesn't in my case.

@eirikm what about add

build:
  haddock: true

to try make links be shown?

also did not

ghc-options:
  '$everything': -haddock

fix the haddock docs for extra deps?