Add LDoc configuration file & generation script

master
Jordan Irwin 2017-08-15 21:19:11 -07:00
parent ed7fb8c3ae
commit 5ac1051911
2 changed files with 32 additions and 0 deletions

22
docs/config.ld Normal file
View File

@ -0,0 +1,22 @@
title = 'Glass'
project = 'Glass Mod for Minetest mods'
format = 'discount'
not_luadoc = true
local function italic(value)
return '<i>' .. value .. '</i>'
end
new_type('node', 'Nodes')
new_type('recipe', 'Craft Recipes')
custom_tags = {
{'rtype',
title = 'Recipe type',
},
{'output',
title = 'Output',
},
{'input',
title = 'Input',
},
}

10
docs/gendoc.sh Executable file
View File

@ -0,0 +1,10 @@
#!/bin/bash
DOCS="$(dirname $(readlink -f $0))"
ROOT="$(dirname ${DOCS})"
CONFIG="${DOCS}/config.ld"
cd "${ROOT}"
rm -rf "${DOCS}/reference"
ldoc -B -c "${CONFIG}" -d "${DOCS}/reference" ./