From 58ce4bf7fbbff2c9027b24bcda51873e1ab2040c Mon Sep 17 00:00:00 2001 From: Jordan Irwin Date: Wed, 5 May 2021 14:22:21 -0700 Subject: [PATCH] Add configuration & script for generating HTML docs with LDoc --- docs/config.ld | 8 ++++++++ docs/gendoc.sh | 12 ++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 docs/config.ld create mode 100644 docs/gendoc.sh diff --git a/docs/config.ld b/docs/config.ld new file mode 100644 index 0000000..9b5a6a4 --- /dev/null +++ b/docs/config.ld @@ -0,0 +1,8 @@ +title = "Creatures Revived" +project = "cmer" +format = "markdown" +not_luadoc = true +--wrap = true +boilerplate = true + +file = {"register.lua", "common.lua"} diff --git a/docs/gendoc.sh b/docs/gendoc.sh new file mode 100644 index 0000000..0f21f92 --- /dev/null +++ b/docs/gendoc.sh @@ -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}"