Skip to content

Commit 09f82c9

Browse files
committed
chore: Release v1.5.0
1 parent da93098 commit 09f82c9

File tree

5 files changed

+113
-5
lines changed

5 files changed

+113
-5
lines changed

CHANGELOG.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
1+
## Version 1.5.0
2+
3+
### Features
4+
* Migrated to lunarmodules org, lowercased repository name, started using 'v' prefix for tags
5+
* Add Dockerfile and publish build to ghcr.io
6+
* Configure repository for use *as* a GitHub Action
7+
* Support CommonMark via cmark-lua processor
8+
* Add `--version` and improve CLI `--help` output
9+
* Add 'new' theme
10+
* Add filetype for xLua's .cs files
11+
* Add options for project icons & favicons
12+
* Distinguish between static/class members in moonscript
13+
* Add support for Lua 5.4
14+
* Add feature to skip adding timestamps to output
15+
* Prettify Lua function names
16+
* Make `@param` tag multiline
17+
* Allow using `@module`, `@script`, `@file`, etc. multiple times in a single source file
18+
* Expand builtin tparam aliases to full type names
19+
* Add `--unsafe_no_sandbox` argument and allow importing Lua modules from config
20+
* Support LLS-style tags for `@param` and `@return`
21+
22+
### Fixes
23+
* Correct documentation typos and errors in example code
24+
* Honor TMPDIR environment variable
25+
* Look for absolute references for `@see` references using module names first
26+
* Use default MD template if none specified
27+
* Recognize backslash separators in moonscript
28+
* Do not remove `@see` references from internal data structure
29+
* Fix Lua 5.1 support
30+
* Cleanup CLI input to remove trailing slashes
31+
132
## Version 1.4.4
233

334
### Features
@@ -35,7 +66,7 @@
3566
* add update time to footer of page
3667
* better C support: `global_lookup=true` - invoked when `parse_extra={C=true}`
3768
* `kind_names` can override names used in sidebar
38-
69+
3970
### Fixes
4071

4172
* `all=true` in `config.ld` did not work.

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ inputs:
77
default: "."
88
runs:
99
using: docker
10-
image: docker://ghcr.io/lunarmodules/ldoc:v1.4.6
10+
image: docker://ghcr.io/lunarmodules/ldoc:v1.5.0
1111
entrypoint: sh
1212
args:
1313
- -c

ldoc-dev-1.rockspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ description = {
2727
]],
2828
homepage="http://lunarmodules.github.io/ldoc",
2929
issues_url = "https://github.com/lunarmodules/ldoc/issues",
30-
maintainer="steve.j.donovan@gmail.com",
30+
maintainer="caleb@alerque.com",
3131
license = 'MIT <http://opensource.org/licenses/MIT>'
3232
}
3333

ldoc.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
--
88
-- C/C++ support for Lua extensions is provided.
99
--
10-
-- Available from LuaRocks as 'ldoc' and as a [Zip file](https://github.com/lunarmodules/ldoc/archive/refs/tags/1.4.6.zip)
10+
-- Available from LuaRocks as 'ldoc' and as a [Zip file](https://github.com/lunarmodules/ldoc/archive/refs/tags/v1.5.0.zip)
1111
--
1212
-- [Github Page](https://github.com/lunarmodules/ldoc)
1313
--
@@ -29,7 +29,7 @@ local tablex = require 'pl.tablex'
2929
utils.unpack = utils.unpack or unpack or table.unpack
3030
local lapp = require 'pl.lapp'
3131

32-
local version = '1.4.6'
32+
local version = '1.5.0'
3333

3434
-- so we can find our private modules
3535
app.require_here()

rockspecs/ldoc-1.5.0-1.rockspec

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
local package_name = "ldoc"
2+
local package_version = "1.5.0"
3+
local rockspec_revision = "1"
4+
local github_account_name = "lunarmodules"
5+
6+
package = package_name
7+
version = package_version .. "-" .. rockspec_revision
8+
9+
source = {
10+
url = "git+https://github.com/" .. github_account_name .. "/" .. package_name .. ".git"
11+
}
12+
13+
if package_version == "dev" then
14+
source.branch = "master"
15+
else
16+
source.tag = "v" .. package_version
17+
end
18+
19+
description = {
20+
summary = "A Lua Documentation Tool",
21+
detailed = [[
22+
LDoc is a LuaDoc-compatible documentation generator which can also
23+
process C extension source. Markdown may be optionally used to
24+
render comments, as well as integrated readme documentation and
25+
pretty-printed example files
26+
]],
27+
homepage="http://lunarmodules.github.io/ldoc",
28+
maintainer="[email protected]",
29+
license = 'MIT <http://opensource.org/licenses/MIT>'
30+
}
31+
32+
dependencies = {
33+
"markdown",
34+
"penlight",
35+
}
36+
37+
build = {
38+
type = "builtin",
39+
modules = {
40+
["ldoc.tools"] = "ldoc/tools.lua",
41+
["ldoc.lang"] = "ldoc/lang.lua",
42+
["ldoc.parse"] = "ldoc/parse.lua",
43+
["ldoc.html"] = "ldoc/html.lua",
44+
["ldoc.lexer"] = "ldoc/lexer.lua",
45+
["ldoc.markup"] = "ldoc/markup.lua",
46+
["ldoc.prettify"] = "ldoc/prettify.lua",
47+
["ldoc.markdown"] = "ldoc/markdown.lua",
48+
["ldoc.doc"] = "ldoc/doc.lua",
49+
["ldoc.html.ldoc_ltp"] = "ldoc/html/ldoc_ltp.lua",
50+
["ldoc.html.ldoc_md_ltp"] = "ldoc/html/ldoc_md_ltp.lua",
51+
["ldoc.html.ldoc_css"] = "ldoc/html/ldoc_css.lua",
52+
["ldoc.html._code_css"] = "ldoc/html/_code_css.lua",
53+
["ldoc.html._reset_css"] = "ldoc/html/_reset_css.lua",
54+
["ldoc.html.ldoc_one_css"] = "ldoc/html/ldoc_one_css.lua",
55+
["ldoc.html.ldoc_pale_css"] = "ldoc/html/ldoc_pale_css.lua",
56+
["ldoc.html.ldoc_new_css"] = "ldoc/html/ldoc_new_css.lua",
57+
["ldoc.html.ldoc_fixed_css"] = "ldoc/html/ldoc_fixed_css.lua",
58+
["ldoc.builtin.globals"] = "ldoc/builtin/globals.lua",
59+
["ldoc.builtin.coroutine"] = "ldoc/builtin/coroutine.lua",
60+
["ldoc.builtin.global"] = "ldoc/builtin/global.lua",
61+
["ldoc.builtin.debug"] = "ldoc/builtin/debug.lua",
62+
["ldoc.builtin.io"] = "ldoc/builtin/io.lua",
63+
["ldoc.builtin.lfs"] = "ldoc/builtin/lfs.lua",
64+
["ldoc.builtin.lpeg"] = "ldoc/builtin/lpeg.lua",
65+
["ldoc.builtin.math"] = "ldoc/builtin/math.lua",
66+
["ldoc.builtin.os"] = "ldoc/builtin/os.lua",
67+
["ldoc.builtin.package"] = "ldoc/builtin/package.lua",
68+
["ldoc.builtin.string"] = "ldoc/builtin/string.lua",
69+
["ldoc.builtin.table"] = "ldoc/builtin/table.lua",
70+
},
71+
copy_directories = {'tests'},
72+
install = {
73+
bin = {
74+
ldoc = "ldoc.lua"
75+
}
76+
}
77+
}

0 commit comments

Comments
 (0)