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

Better publishing of our project Haddocks #453

Closed
michaelpj opened this issue Jan 7, 2019 · 1 comment
Closed

Better publishing of our project Haddocks #453

michaelpj opened this issue Jan 7, 2019 · 1 comment
Assignees

Comments

@michaelpj
Copy link
Contributor

At the moment there's a manually generated dump of some of the Haddock on our GH pages, but this is very ad hoc.

It would be better to generate a nice, combined Haddock bundle for all of our packages, and do so on the CI so we can always be pointing to an automatically generated, up to date version.

However, this is a bit annoying, since the Haddocks generated with Nix have links pointing at dependent packages in the store, so it'll be hard to stitch them together so the links point at each other instead.

cabal new-haddock seems promising for this, but I was unable to get it to work:

  • It requires cabal new-build to work for starters
  • It requires network access (offline mode is broken)

Might be able to do this ourselves with a bit of creativity.

@michaelpj michaelpj self-assigned this Jan 7, 2019
@michaelpj
Copy link
Contributor Author

This is a lot better, I'm closing it as done for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants