Skip to content
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

Leveling Up - Generating documentation with haddock #22

Open
JonathanLorimer opened this issue Jul 1, 2021 · 0 comments
Open

Leveling Up - Generating documentation with haddock #22

JonathanLorimer opened this issue Jul 1, 2021 · 0 comments
Labels
Leveling Up Section label for leveling up New Chapter

Comments

@JonathanLorimer
Copy link
Contributor

file to edit: https://github.com/haskell/cabal-userguide/blob/main/src/leveling_up/05_generating_documentation_with_haddock.md

Brief Summary

In my opinion this is a relatively undocumented aspect of cabal. I think that it can be very mysterious to beginners, it is also really useful to be able to locally host project specific haddocks. It can also be confusing when misconfigured i.e. you are building haddocks on every build / ghcid recompilation. While this shouldn't be a haddock reference guide, it might be useful to cover some of the basic / more common haddock syntax in the example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Leveling Up Section label for leveling up New Chapter
Projects
Development

No branches or pull requests

1 participant