Rarity

Rarity

17M Downloads

Add GitHub Actions workflow to auto-generate API references when a release is created

rdw-software opened this issue ยท 0 comments

commented

Goals:

  • On release trigger, the CI will create an updated API reference for that version
  • This documentation should automatically become available on the documentation website (a link might suffice?)
  • Between releases, we can update the documentation manually by running a script that does the same (convenience)

Roadmap:

  • Add GitHub Actions workflow ldoc.yaml that installs luarocks (copy/paste from luacheck.yaml), penlight (via luarocks install penlight) and then runs ldoc (via lua /path/to/ldoc/ldoc.lua $*)

See also: