Stream: beginners

Topic: Is roc-docs broken?

view this post on Zulip Luke Boswell (Feb 25 2023 at 08:15):

Is roc docs broken? I can't figure out how to get it to generate docs for basic-cli, which I'm sure I've done before. I've tried running almost the same command as we have in www/build.sh except just using a release build of roc cli.

luke@192-168-1-104 basic-cli % ls
LICENSE         ci          file-testBROKEN.roc flake.nix       src
README.md       examples        flake.lock      generated-docs
luke@192-168-1-104 basic-cli % roc docs src/*.roc
🎉 Docs generated in ./generated-docs
luke@192-168-1-104 basic-cli % ls generated-docs
favicon.svg search.js   styles.css

view this post on Zulip Anton (Feb 25 2023 at 08:32):

Yes, sort of, it's because of an issue in exposing modules. The fix is pretty complex but Richard is working on it.

view this post on Zulip Luke Boswell (Feb 25 2023 at 08:42):

Ahk, I started trying to find the issue. I figured out the VecMap docs_by_module: VecMap<ModuleId, ModuleDocumentation> on LoadedModule is empty. And then was looking at the HeaderType in crates/compiler/load_internal/src/file.rs and figured out it must have something to do with if the module is exposed by the platform... I'll pause on this one. Thanks Anton.

view this post on Zulip Richard Feldman (Feb 25 2023 at 14:12):

I have 2 different talks due next week, but I plan to get back to this afterwards!

Last updated: Jul 05 2025 at 12:14 UTC