Crystal docs - crystal src errors

Help & Support
1

when I try to run crystal docs from crystal src directory it errors

2

Can you give the command you ran and the exact error it returned?

3

You’re supposed to run it from the root of the project not within src/.

EDIT: Assuming this your own project and not the actual crystal compiler repo.

4

Just call make docs.

You must use bin/crystal and the src/docs_main.cr entrypoint to avoid requiring everything from the src folder.

5

I ran it from the crystal-lang/crystal root . Trying to get a local copy of docs

6

Ah, yea in that case you’d want to do make docs. But really if all you want is an offline copy of the docs you can just download it from the latest GH release. Which as of now would be https://github.com/crystal-lang/crystal/releases/download/1.17.1/crystal-1.17.1-docs.tar.gz.

1 Like