cyan icon indicating copy to clipboard operation
cyan copied to clipboard

The API documentation is unavailable

Open Aire-One opened this issue 2 years ago • 1 comments

Hello, :wave:

It seems the link from the README https://teal-language.github.io/cyan/ is down. According to https://github.com/teal-language/cyan/actions/runs/4219037124, the page has expired.

I tried to clone the repo and run make docs, but it fails with

make docs
tl --quiet -I src gen --check src/cyan/graph.tl -o build/cyan/graph.lua
========================================
2 errors:
src/cyan/fs/path.tl:5:28: module not found: 'lfs'
src/cyan/fs/path.tl:274:30: assignment in declaration did not produce an initial value for variable 'err'
========================================
1 error:
src/cyan/fs/init.tl:5:28: module not found: 'lfs'
make: *** [Makefile:12: build/cyan/graph.lua] Error 1

Aire-One avatar Aug 15 '23 12:08 Aire-One

Ok so, after some playing around and reinstalling the dependencies (luafilesystem) and rebuilding the rock from the rockspec again, I finally sorted out this require("lfs") issue.

I'm not done yet, tho. docgen.lua depends on tree-sitter and the parser from https://github.com/euclidianAce/tree-sitter-teal. After generating the parser.so and moved it as ./teal.so in the working directory, I have the error:

make docs
./bin/cyan run scripts/docgen.tl
    Docgen Processed cyan/ansi.tl
    Docgen Processed cyan/colorstring.tl
malloc(): invalid next size (unsorted)
make: *** [Makefile:50: docs/index.html] Aborted (core dumped)

Aire-One avatar Aug 22 '23 18:08 Aire-One