Fork of Tangara with customizations
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。
 
 
 
 
 
 
tangara-fw/tools/luals-gendoc
jacqueline 3d484211a5 Add reference doc regen instructions 1年前
..
README.md Add reference doc regen instructions 1年前
gendoc.lua Bring a modified luavgl stub file into our stubs 2年前
json.lua Use luals-stubs as the source of truth for docs, instead of maintaining 2年前

README.md

Prerequisites

  • lua-language-server
  • a Lua interpreter version >= 5.2

Regenerating the Lua reference docs

  1. Invoke lua-language-server to parse our stubs, generating json output:
$ lua-language-server --doc=../../luals-stubs
  1. The output will include the path to the raw json data. This will be a path like '/home/jacqueline/Development/lua-language-server/log/doc.json'. Pipe this file to gendoc.lua. The output will be quite long; consider piping to less for testing.
$ cat /home/jacqueline/Development/lua-language-server/log/doc.json | ./gendoc.lua | less
  1. If updating the public-facing docs on cooltech.zone, place the resulting output in 'content/tangara/docs/lua/reference.txt'.