Skip to content

Commit

Permalink
chore: Release v1.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
alerque committed May 2, 2023
1 parent da93098 commit 09f82c9
Show file tree
Hide file tree
Showing 5 changed files with 113 additions and 5 deletions.
33 changes: 32 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
## Version 1.5.0

### Features
* Migrated to lunarmodules org, lowercased repository name, started using 'v' prefix for tags
* Add Dockerfile and publish build to ghcr.io
* Configure repository for use *as* a GitHub Action
* Support CommonMark via cmark-lua processor
* Add `--version` and improve CLI `--help` output
* Add 'new' theme
* Add filetype for xLua's .cs files
* Add options for project icons & favicons
* Distinguish between static/class members in moonscript
* Add support for Lua 5.4
* Add feature to skip adding timestamps to output
* Prettify Lua function names
* Make `@param` tag multiline
* Allow using `@module`, `@script`, `@file`, etc. multiple times in a single source file
* Expand builtin tparam aliases to full type names
* Add `--unsafe_no_sandbox` argument and allow importing Lua modules from config
* Support LLS-style tags for `@param` and `@return`

### Fixes
* Correct documentation typos and errors in example code
* Honor TMPDIR environment variable
* Look for absolute references for `@see` references using module names first
* Use default MD template if none specified
* Recognize backslash separators in moonscript
* Do not remove `@see` references from internal data structure
* Fix Lua 5.1 support
* Cleanup CLI input to remove trailing slashes

## Version 1.4.4

### Features
Expand Down Expand Up @@ -35,7 +66,7 @@
* add update time to footer of page
* better C support: `global_lookup=true` - invoked when `parse_extra={C=true}`
* `kind_names` can override names used in sidebar

### Fixes

* `all=true` in `config.ld` did not work.
Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ inputs:
default: "."
runs:
using: docker
image: docker://ghcr.io/lunarmodules/ldoc:v1.4.6
image: docker://ghcr.io/lunarmodules/ldoc:v1.5.0
entrypoint: sh
args:
- -c
Expand Down
2 changes: 1 addition & 1 deletion ldoc-dev-1.rockspec
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ description = {
]],
homepage="http://lunarmodules.github.io/ldoc",
issues_url = "https://github.com/lunarmodules/ldoc/issues",
maintainer="steve.j.donovan@gmail.com",
maintainer="caleb@alerque.com",
license = 'MIT <http://opensource.org/licenses/MIT>'
}

Expand Down
4 changes: 2 additions & 2 deletions ldoc.lua
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
--
-- C/C++ support for Lua extensions is provided.
--
-- Available from LuaRocks as 'ldoc' and as a [Zip file](https://github.com/lunarmodules/ldoc/archive/refs/tags/1.4.6.zip)
-- Available from LuaRocks as 'ldoc' and as a [Zip file](https://github.com/lunarmodules/ldoc/archive/refs/tags/v1.5.0.zip)
--
-- [Github Page](https://github.com/lunarmodules/ldoc)
--
Expand All @@ -29,7 +29,7 @@ local tablex = require 'pl.tablex'
utils.unpack = utils.unpack or unpack or table.unpack
local lapp = require 'pl.lapp'

local version = '1.4.6'
local version = '1.5.0'

-- so we can find our private modules
app.require_here()
Expand Down
77 changes: 77 additions & 0 deletions rockspecs/ldoc-1.5.0-1.rockspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
local package_name = "ldoc"
local package_version = "1.5.0"
local rockspec_revision = "1"
local github_account_name = "lunarmodules"

package = package_name
version = package_version .. "-" .. rockspec_revision

source = {
url = "git+https://github.com/" .. github_account_name .. "/" .. package_name .. ".git"
}

if package_version == "dev" then
source.branch = "master"
else
source.tag = "v" .. package_version
end

description = {
summary = "A Lua Documentation Tool",
detailed = [[
LDoc is a LuaDoc-compatible documentation generator which can also
process C extension source. Markdown may be optionally used to
render comments, as well as integrated readme documentation and
pretty-printed example files
]],
homepage="http://lunarmodules.github.io/ldoc",
maintainer="[email protected]",
license = 'MIT <http://opensource.org/licenses/MIT>'
}

dependencies = {
"markdown",
"penlight",
}

build = {
type = "builtin",
modules = {
["ldoc.tools"] = "ldoc/tools.lua",
["ldoc.lang"] = "ldoc/lang.lua",
["ldoc.parse"] = "ldoc/parse.lua",
["ldoc.html"] = "ldoc/html.lua",
["ldoc.lexer"] = "ldoc/lexer.lua",
["ldoc.markup"] = "ldoc/markup.lua",
["ldoc.prettify"] = "ldoc/prettify.lua",
["ldoc.markdown"] = "ldoc/markdown.lua",
["ldoc.doc"] = "ldoc/doc.lua",
["ldoc.html.ldoc_ltp"] = "ldoc/html/ldoc_ltp.lua",
["ldoc.html.ldoc_md_ltp"] = "ldoc/html/ldoc_md_ltp.lua",
["ldoc.html.ldoc_css"] = "ldoc/html/ldoc_css.lua",
["ldoc.html._code_css"] = "ldoc/html/_code_css.lua",
["ldoc.html._reset_css"] = "ldoc/html/_reset_css.lua",
["ldoc.html.ldoc_one_css"] = "ldoc/html/ldoc_one_css.lua",
["ldoc.html.ldoc_pale_css"] = "ldoc/html/ldoc_pale_css.lua",
["ldoc.html.ldoc_new_css"] = "ldoc/html/ldoc_new_css.lua",
["ldoc.html.ldoc_fixed_css"] = "ldoc/html/ldoc_fixed_css.lua",
["ldoc.builtin.globals"] = "ldoc/builtin/globals.lua",
["ldoc.builtin.coroutine"] = "ldoc/builtin/coroutine.lua",
["ldoc.builtin.global"] = "ldoc/builtin/global.lua",
["ldoc.builtin.debug"] = "ldoc/builtin/debug.lua",
["ldoc.builtin.io"] = "ldoc/builtin/io.lua",
["ldoc.builtin.lfs"] = "ldoc/builtin/lfs.lua",
["ldoc.builtin.lpeg"] = "ldoc/builtin/lpeg.lua",
["ldoc.builtin.math"] = "ldoc/builtin/math.lua",
["ldoc.builtin.os"] = "ldoc/builtin/os.lua",
["ldoc.builtin.package"] = "ldoc/builtin/package.lua",
["ldoc.builtin.string"] = "ldoc/builtin/string.lua",
["ldoc.builtin.table"] = "ldoc/builtin/table.lua",
},
copy_directories = {'tests'},
install = {
bin = {
ldoc = "ldoc.lua"
}
}
}

0 comments on commit 09f82c9

Please sign in to comment.