documentation

[KiaraGrouwstra]

I generate Haddock docs by stack haddock; it'd be nice if I could do this in CD and expose them over Github Pages to give a nicer overview of my codebase.

• Haddock dumps docs to like ~/.stack/snapshots/x86_64-linux-tinfo6/d0f773766cf7d1b82a65f6a6382f1602be268df7432f634a9ecf097c05200ede/8.6.5/doc/. should I grep this from stack haddock in CI/CD to create some symlink? allegedly overriding the is output path is futile.
• deploy
• set Github Pages branch
• my haddock docs seem to include my deps yet not my code?
• the docs end up with broken links based on absolute URLs like this -- I now filed this here.

[KiaraGrouwstra]

uhhh getting this out of a Docker seems tough without Stack complaining about ownership, so I may need a Haskell Travis...

[KiaraGrouwstra]

First attempt here (build)...

[KiaraGrouwstra]

I managed to deploy Haddock to Github pages now. That leaves the question why it documents my deps yet not my own code...

[KiaraGrouwstra]

I pushed a fix for that last bit now, but the proper doc directory doesn't get repeated if re-running the command, while capturing the whole thing thru grep seems prone to make Travis error if doc generation takes >10m... as a workaround I hard-coded the doc path now, but this is dependent on the Cabal version used. At least CI will complain when this goes wrong.

[KiaraGrouwstra]

so uh Nix broke my CI so I'll wanna somehow salvage what I had using this.

[KiaraGrouwstra]

for some reason the new Github action isn't running yet. weird.

[KiaraGrouwstra]

ohh, it was running, see https://github.com/tycho01/synthesis/actions

[KiaraGrouwstra]

while the action runs now, going to https://tycho01.github.io/synthesis/, I don't see any content, while the JS console complains of a missing doc-index.json. Pressing QuickJump gives a popup stating that as well.

[KiaraGrouwstra]

ohh, hasktorch is missing the json file too -- their content just works anyway.

[KiaraGrouwstra]

fwiw debugging should consist of just manually running the commands in a terminal then tweaking them until I know what configuration produces something good.