Skip to content

Install documentation for Haskell dependencies #52

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.

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

Open
georgefst opened this issue Sep 14, 2021 · 5 comments
Open

Install documentation for Haskell dependencies #52

georgefst opened this issue Sep 14, 2021 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@georgefst
Copy link
Contributor

We enabled doHaddock in 8ae175805d1e43ec88d89ba887b8795cc6f7d2fc, which gives us docs on hover in HLS, and therefore must be passing -haddock to GHC. But it's not clear from the documentation whether it's also supposed to replicate Cabal's --enable-documentation flag, which is required for full Haddock browsing functionality in HLS.

Relatedly, cabal haddock vonnegut (or make docs) produces HTML which doesn't contain any links to definitions from external packages, even base. In cabal-based projects, without Nix, I've found that links to libraries which ship with GHC (base, containers, stm etc.) are always present, and --enable-documentation is required for third-party libs.

@dhess
Copy link
Member

dhess commented Sep 14, 2021

If we set --enable-documentation in our Cabal files, does that fix both issues?

@georgefst
Copy link
Contributor Author

If we set --enable-documentation in our Cabal files, does that fix both issues?

No, it doesn't seem to make any visible difference.

(that is, adding documentation: True to vonnegut/backend/cabal.project, which should be the same as passing --enable-documentation to every invocation of cabal build etc.)

@dhess
Copy link
Member

dhess commented Sep 14, 2021

Can you file this as an issue against haskell.nix? It sounds like something might be going on under the hood that's causing this not to work as expected.

@georgefst
Copy link
Contributor Author

Can you file this as an issue against haskell.nix?

Sure. I might need to keep it simple and tag you if they have any questions though - I'm not too sure on the details of our setup.

@dhess
Copy link
Member

dhess commented Sep 14, 2021

As mentioned in chat, I'll deal with this as I'm fairly familiar with haskell.nix and the maintainers.

@dhess dhess transferred this issue from another repository Sep 18, 2021
@dhess dhess added the documentation Improvements or additions to documentation label Sep 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants