From 958d45775c2d664c4a712cc7deb94a67dc24d6e5 Mon Sep 17 00:00:00 2001 From: Jordan Irwin Date: Mon, 12 Jul 2021 08:58:55 -0700 Subject: [PATCH] Add script & config for generating HTML docs with LDoc --- docs/config.ld | 4 ++++ docs/gendoc.sh | 13 +++++++++++++ 2 files changed, 17 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..25b7626 --- /dev/null +++ b/docs/config.ld @@ -0,0 +1,4 @@ +project = "Cleaner" +title = "Cleaner mod for Minetest" +format = "markdown" +boilerplate = false diff --git a/docs/gendoc.sh b/docs/gendoc.sh new file mode 100644 index 0000000..8cdda6b --- /dev/null +++ b/docs/gendoc.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +docs="$(dirname $(readlink -f $0))" +root="$(dirname ${docs})" +config="${docs}/config.ld" + +cd "${root}" + +# Clean old files +rm -rf "${docs}/api" + +# Create new files +ldoc -c "${config}" -d "${docs}/api" "${root}/api.lua"