diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index a1df1bf..0f08e1e 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -47,10 +47,11 @@ jobs: # Only clean references directory rm -rf gh-pages/docs/references - mkdir -p gh-pages/docs/references + mkdir -p gh-pages/docs/references - name: Generate Documentation run: | + mkdir -p build_docs/docs/references lua tools/generate-docs.lua cp -r build_docs/docs/references/* gh-pages/docs/references/ diff --git a/src/elements/Tree.lua b/src/elements/Tree.lua index 070d0d7..b3711e7 100644 --- a/src/elements/Tree.lua +++ b/src/elements/Tree.lua @@ -2,6 +2,7 @@ local VisualElement = require("elements/VisualElement") local sub = string.sub ---@cofnigDescription The tree element provides a hierarchical view of nodes that can be expanded and collapsed, with support for selection and scrolling. + --- This is the tree class. It provides a hierarchical view of nodes that can be expanded and collapsed, --- with support for selection and scrolling. ---@class Tree : VisualElement diff --git a/tools/generate-docs.lua b/tools/generate-docs.lua index 76f6cb6..8ed6ca6 100644 --- a/tools/generate-docs.lua +++ b/tools/generate-docs.lua @@ -48,7 +48,7 @@ else if not success then return {} end - + local items = {} for item in result:gmatch("[^\r\n]+") do if item ~= "" then @@ -85,7 +85,10 @@ else end if not fileSystem.exists(OUT_DIR) then + print("Output directory does not exist, creating it...") fileSystem.makeDir(OUT_DIR) +else + print("Output directory already exists") end local function getLuaFiles(dir) @@ -106,6 +109,7 @@ local function getLuaFiles(dir) end local luaFiles = getLuaFiles(SRC_DIR) +print("Found " .. #luaFiles .. " Lua files to process") for _, filePath in ipairs(luaFiles) do local file = fileSystem.open(filePath, "r")