Test

.github/workflows/docs.yml

@@ -1,3 +1,4 @@
+# Based on https://gist.github.com/domenic/ec8b0fc8ab45f39403dd
 name: Build Docs
 on:
   pull_request:
@@ -19,13 +20,13 @@ jobs:
         luaVersion: 5.4
     - name: Setup Lua Rocks
       uses: leafo/gh-actions-luarocks@v4
-    - name: Install LDoc
+    - name: Setup dependencies
       run: luarocks install ldoc
     - name: Build docs
       run: make doc-site
     - name: Deploy
-      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
       uses: peaceiris/actions-gh-pages@v3
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./docs
+        publish_dir: ./out

Makefile

@@ -1,3 +1,4 @@
+
 LUA= $(shell echo `which lua`)
 LUA_BINDIR= $(shell echo `dirname $(LUA)`)
 LUA_PREFIX= $(shell echo `dirname $(LUA_BINDIR)`)
@@ -30,10 +31,10 @@ uninstall:
 
 test: test-basic test-example test-md test-tables
 
-RUN=&& lua $(_REPODIR)/ldoc.lua . && diff -r docs cdocs && echo ok
+RUN=&& lua $(_REPODIR)/ldoc.lua . && diff -r doc cdocs && echo ok
 
 test-prep:
-	find -type d -name docs -execdir rsync -av --del {}/ cdocs/ \;
+	find -type d -name doc -execdir rsync -av --del {}/ cdocs/ \;
 
 test-basic:
 	cd tests $(RUN)
@@ -50,9 +51,9 @@ test-tables:
 test-clean: clean-basic clean-example clean-md clean-tables
 
 doc-site:
-	cd $(_REPODIR)/docs && lua $(_REPODIR)/ldoc.lua .
+	cd $(_REPODIR)/doc && lua $(_REPODIR)/ldoc.lua .
 
-CLEAN=&& lua $(_REPODIR)/ldoc.lua . && rd /S /Q cdocs && cp -rf docs cdocs
+CLEAN=&& lua $(_REPODIR)/ldoc.lua . && rd /S /Q cdocs && cp -rf doc cdocs
 
 clean-basic:
 	cd tests $(CLEAN)
@@ -64,4 +65,4 @@ clean-md:
 	cd tests && cd md-test $(CLEAN)
 
 clean-tables:
-	cd tests && cd simple $(CLEAN)
+	cd tests && cd simple $(CLEAN)

config.ld

@@ -2,6 +2,6 @@ project = 'Basalt2'
 title = 'Basalt Documentation'
 description = 'A UI Framework for ComputerCraft'
 file = {'src'}
-dir = 'docs'
+dir = 'out'
 format = 'markdown'
 all = true