Attempt automatic doc gen

This commit is contained in:
Ottatop 2023-08-26 22:26:32 -05:00
parent bfa4e2743b
commit 694134582d
4 changed files with 7 additions and 2 deletions

View file

@ -32,12 +32,14 @@ jobs:
uses: leafo/gh-actions-luarocks@v4
- name: Setup dependencies
run: luarocks install ldoc
- name: Generate LDoc compatible code
run: git clone https://github.com/Ottatop/ldoc_gen --depth 1 && cd ./ldoc_gen && cargo run -- -p ../api/lua
- name: Build docs
run: cd ./api/lua/doc && ldoc . && cd ../../..
run: cd ./.ldoc_gen && cp ../../api/lua/doc/ldoc.css ../../api/lua/doc/config.ld . && ldoc . && cd ../..
- name: Deploy
if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }}
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./api/lua/doc/doc
publish_dir: ./ldoc_gen/.ldoc_gen/doc
destination_dir: ${{ env.BRANCH_NAME }}

View file

@ -3,6 +3,7 @@
---@class OutputModule
local output_module = {}
---@classmod
---@class Output A display.
---@field private _name string The name of this output (or rather, of its connector).
local output = {}

View file

@ -15,6 +15,7 @@ local tag_module = {}
---@alias TagTable { [1]: string, [2]: (string|Output)? }
---@alias TagTableNamed { name: string, output: (string|Output)? }
---@classmod
---@class Tag
---@field private _id integer The internal id of this tag.
local tag = {}

View file

@ -3,6 +3,7 @@
---@class WindowModule
local window_module = {}
---@classmod
---@class Window
---@field private _id integer The internal id of this window
local window = {}