mirror of
https://github.com/pinnacle-comp/pinnacle.git
synced 2025-01-30 20:34:49 +01:00
Attempt automatic doc gen
This commit is contained in:
parent
bfa4e2743b
commit
694134582d
4 changed files with 7 additions and 2 deletions
6
.github/workflows/ldoc.yml
vendored
6
.github/workflows/ldoc.yml
vendored
|
@ -32,12 +32,14 @@ jobs:
|
||||||
uses: leafo/gh-actions-luarocks@v4
|
uses: leafo/gh-actions-luarocks@v4
|
||||||
- name: Setup dependencies
|
- name: Setup dependencies
|
||||||
run: luarocks install ldoc
|
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
|
- 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
|
- name: Deploy
|
||||||
if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }}
|
if: ${{ github.event_name == 'push' || github.event_name == 'pull_request' }}
|
||||||
uses: peaceiris/actions-gh-pages@v3
|
uses: peaceiris/actions-gh-pages@v3
|
||||||
with:
|
with:
|
||||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
publish_dir: ./api/lua/doc/doc
|
publish_dir: ./ldoc_gen/.ldoc_gen/doc
|
||||||
destination_dir: ${{ env.BRANCH_NAME }}
|
destination_dir: ${{ env.BRANCH_NAME }}
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
---@class OutputModule
|
---@class OutputModule
|
||||||
local output_module = {}
|
local output_module = {}
|
||||||
|
|
||||||
|
---@classmod
|
||||||
---@class Output A display.
|
---@class Output A display.
|
||||||
---@field private _name string The name of this output (or rather, of its connector).
|
---@field private _name string The name of this output (or rather, of its connector).
|
||||||
local output = {}
|
local output = {}
|
||||||
|
|
|
@ -15,6 +15,7 @@ local tag_module = {}
|
||||||
---@alias TagTable { [1]: string, [2]: (string|Output)? }
|
---@alias TagTable { [1]: string, [2]: (string|Output)? }
|
||||||
---@alias TagTableNamed { name: string, output: (string|Output)? }
|
---@alias TagTableNamed { name: string, output: (string|Output)? }
|
||||||
|
|
||||||
|
---@classmod
|
||||||
---@class Tag
|
---@class Tag
|
||||||
---@field private _id integer The internal id of this tag.
|
---@field private _id integer The internal id of this tag.
|
||||||
local tag = {}
|
local tag = {}
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
---@class WindowModule
|
---@class WindowModule
|
||||||
local window_module = {}
|
local window_module = {}
|
||||||
|
|
||||||
|
---@classmod
|
||||||
---@class Window
|
---@class Window
|
||||||
---@field private _id integer The internal id of this window
|
---@field private _id integer The internal id of this window
|
||||||
local window = {}
|
local window = {}
|
||||||
|
|
Loading…
Add table
Reference in a new issue