From 1ccced0e8ab8180009f33be670f02f682108f388 Mon Sep 17 00:00:00 2001 From: David Briscoe Date: Wed, 23 Jun 2021 00:13:54 -0700 Subject: [PATCH] Add info for how to generate ldoc in gh actions Help people run the same process themselves. --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index bd21bb2..f8a39f1 100644 --- a/README.md +++ b/README.md @@ -57,3 +57,21 @@ Or a batch file called 'ldoc.bat': @echo off lua \path\to\ldoc\ldoc.lua %* + +## Generating LDoc on github + +To generate docs for your own lua projects see [doc.yml](.github/workflows/doc.yml). + +Instead of `luarocks install --only-deps`, use `luarocks install +https://raw.githubusercontent.com/lunarmodules/LDoc/master/ldoc-scm-3.rockspec` +and create your own `doc-site` makefile target that runs `ldoc .` in the +directory containing your `config.ld`. + +Ensure `publish_dir` in your doc.yml is set to the same location as your +`config.ld`'s `dir` parameter. + +After you've pushed that change to master, you'll see the build cycle on your +commit (an orange dot or green checkmark). When that completes, a repo owner +needs to enable gh-pages on the repository: Settings > Pages and set "Source" to +gh-pages and root. +