MightyPork
/
tangara-fw
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Fork of Tangara with customizations
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1264 Commits
3 Branches
0 Tags
109 MiB
 
 
 
 
 
 
Tag: Branch: Tree: 43b354ee1c
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '43b354ee1c'
${ noResults }
tangara-fw/tools/luals-gendoc
History
Tom Kirchner d6db4b0826
Add missing copyright/license headers 		7 months ago
..
README.md Add reference doc regen instructions 11 months ago
gendoc.lua Add missing copyright/license headers 7 months ago
json.lua Use luals-stubs as the source of truth for docs, instead of maintaining 1 year ago

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'.