The Crystal Programming Language Forum

How to build crystal docs?

I was attempting to build the documentation I find here:

https://crystal-lang.org/api/0.33.0/

But it blows up. Am I missing something? Is there some magic needed to generate them?

crystal$ ./bin/crystal docs
Using compiled compiler at .build/crystal
Showing last frame. Use --error-trace for full trace.

In src/windows_stubs.cr:1:1

 1 | require "c/synchapi"
     ^
Error: can't find file 'c/synchapi'

If you're trying to require a shard:
- Did you remember to run `shards install`?
- Did you make sure you're running the compiler in the same directory as your shard.yml?

make docs

It exists exactly because the usual ways blows up

1 Like

Thanks!