Add configuration & script for generating HTML docs with LDoc

master
Jordan Irwin 2021-05-05 14:22:21 -07:00
parent 4b1f89d470
commit 58ce4bf7fb
2 changed files with 20 additions and 0 deletions

8
docs/config.ld Normal file
View File

@ -0,0 +1,8 @@
title = "Creatures Revived"
project = "cmer"
format = "markdown"
not_luadoc = true
--wrap = true
boilerplate = true
file = {"register.lua", "common.lua"}

12
docs/gendoc.sh Normal file
View 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"
# Create new files
ldoc -c "${CONFIG}" -d "${DOCS}" -o "api" "${ROOT}"