Add config & script for generating HTML docs with LDoc

This commit is contained in:
Jordan Irwin 2021-05-27 23:38:02 -07:00
parent f9e169b945
commit 85970df24b
2 changed files with 21 additions and 0 deletions

9
docs/config.ld Normal file

@ -0,0 +1,9 @@
project = "wconfig"
title = "World Config"
format = "markdown"
not_luadoc = true
boilerplate = false
file = "api.lua"
new_type("falias", "Aliases")

12
docs/gendoc.sh Normal file

@ -0,0 +1,12 @@
#!/bin/bash
DOCS="$(dirname $(readlink -f $0))"
ROOT="$(dirname ${DOCS})"
CONFIG="${DOCS}/config.ld"
cd "${ROOT}"
# Clean old files
rm -rf "${DOCS}/api.html" "${DOCS}/scripts" "${DOCS}/modules" "${DOCS}/source"
# Create new files
ldoc -c "${CONFIG}" -d "${DOCS}" -o "api" "${ROOT}"