doc packages

[mightyiam]

I am finding myself in some project using crane to build cargo doc generated docs and export those as flake packages. I'm not sure anyone would ever build those docs. That project also publishes those docs:

https://molybdenumsoftware.github.io/pr-tracker/programs/pr_tracker_fetcher_config/struct.Environment.html
https://molybdenumsoftware.github.io/pr-tracker/programs/pr_tracker_api_config/struct.Environment.html

Perhaps nci could create a doc package per crate?

[yusdacra]

we could do this yeah. having a <project-name>-docs output probably would be sufficient, checkPhase would run cargo test --doc.

[mightyiam]

I'd vote for "take your time and do it properly" 👍

[yusdacra]

well, the thing is, it could possibly take a long time since this could touch a lot of stuff in dream2nix potentially, and i probably won't be working on it in the near future as i don't consider it high prio enough to matter. i'll probably do the latter option and add doc packages for each crate and use doc-merge in a combined derivation, this way it'll "work as intended" and later on could replace it to be an actual cargo doc derivation.

[mightyiam]

At least in my case, I pass --no-deps and --package foo --package bar to list some specific packages.

[yusdacra]

i pushed generating doc package for each crate, so it will be under the docs attribute of a crate's outputs. i'll probably look into how to combine those later, i have some ideas but for now this should be somewhat adequate. it does run with --no-deps since i can't think of any case where you'd want the deps really (other than convenience i suppose but if someone wants that they can just override the build phase /shrug)

[yusdacra]

ok, just pushed combined docs. it will just put them under project outputs (named docs). can specify docsIndexCrate with a crate name that will have it's index.html be symlinked to the drv root to be more convenient to serve with some local http file server. it should hopefully work fine for more complex projects but i have not tested it with anything particularly complex.