amazonka icon indicating copy to clipboard operation
amazonka copied to clipboard

Haddocks for `main` provided by CI

Open jhrcek opened this issue 1 year ago • 6 comments

We should have CI produce haddocks for main, and upload them to amazonka.brendanhay.nz.


Original Text: The documentation page https://amazonka.brendanhay.nz/ is missing haddocks for amazonka-ec2. Is this a bug in docs generating logic or something?

jhrcek avatar May 13 '23 07:05 jhrcek

Unfortunately with the recent Bazel -> Nix Flake changes to the builds the docs are not being generated. I'd really like to use the Cabal haddock-project command - but it's still not generally available, see: https://github.com/brendanhay/amazonka/pull/906

If there's no movement here I'll probably just end up with some interim hack to try and package and upload the docs. Apologies for any confusion!

brendanhay avatar May 13 '23 09:05 brendanhay

Thanks for explanation and for working on this package. It's not critical. I guess it would be enough for my purposes to check the docs on hackage later, once 2.0 is released.

jhrcek avatar May 13 '23 09:05 jhrcek

@brendanhay Would it be possible to generate the docs using a pre-release cabal-install build? After all, most users will consume the docs in rendered form. Most users aren't working on amazonka itself, so they wouldn't need the custom cabal-install build.

ysangkok avatar Jun 24 '23 12:06 ysangkok

I'm sorry, I don't understand this question.

endgame avatar Jun 24 '23 21:06 endgame

I think @ysangkok is asking about the haddock-project command which would require using a pre-release cabal-install to generate a standalone haddock bundle we could serve from GitHub pages.

We could try it out in a separate CI job - It'd be worth an experiment to know how long the docs build takes and if it is as trivial as pushing the resulting artefact as a GH pages branch, it'd be nice to have docs for main again.

brendanhay avatar Jun 24 '23 21:06 brendanhay

cabal haddock-project appears to be in cabal-install 3.10. Someone should test this and see if we can CI documentation. I'll retitle this issue.

endgame avatar Aug 04 '23 23:08 endgame