py-lua-doc
A Lua documentation extraction tool written in Python that support emmy-lua and ldoc doc-comment.
It's both a development library and a command line tool.
Given a lua source file, it creates a documentation model.
Installation
The package can be installed through pip:
$ pip3 install luadoc
It will install the shell command 'luadoc'.
How to generate documentation ?
This project is part of a Sphinx documentation plugin: sphinx-lua
Node Structure
The node structure is for now only described in model.py
Command Line
The command line tool just serialize the tree to Json.
Given:
--- @class foo.Base
local Base = {}
--- @class foo.List: foo.Base
local List = {}
--- Apply a function to all elements.
--- Any extra arguments will be passed to the function.
--- @param fun fun(a:any):any a function of at least one argument
--- @vararg any @arbitrary extra arguments.
--- @return foo.List a new list: {f(x) for x in self}
function List:map(fun, ...) end
--- Split a string using a delim.
--- @param delim string the delim (default " ")
--- @overload fun()
function List:split(delim) end
return List
$ luadoc source.lua
The following output will be produced:
{
"filename": "test.lua",
"classes": [
{
"name": "foo.Base",
"name_in_source": "Base",
"methods": [],
"desc": "",
"usage": "",
"inherits_from": [],
"fields": []
},
{
"name": "foo.List",
"name_in_source": "List",
"methods": [
{
"name": "map",
"short_desc": "Apply a function to all elements.",
"desc": "Any extra arguments will be passed to the function.",
"params": [
{
"name": "fun",
"desc": "a function of at least one argument",
"type": {
"id": "callable",
"arg_types": [
{
"id": "any"
}
],
"return_types": [
{
"id": "any"
}
]
},
"is_opt": false,
"default_value": ""
},
{
"name": "...",
"desc": "arbitrary extra arguments.",
"type": {
"id": "any"
},
"is_opt": false,
"default_value": ""
}
],
"returns": [
{
"desc": "a new list: {f(x) for x in self}",
"type": {
"id": "custom",
"name": "foo.List"
}
}
],
"usage": "",
"is_virtual": false,
"is_abstract": false,
"is_deprecated": false,
"is_static": false,
"visibility": "public"
},
{
"name": "split",
"short_desc": "Split a string using a delim.",
"desc": "",
"params": [
{
"name": "delim",
"desc": "the delim (default \" \")",
"type": {
"id": "string"
},
"is_opt": false,
"default_value": ""
}
],
"returns": [],
"usage": "",
"is_virtual": false,
"is_abstract": false,
"is_deprecated": false,
"is_static": false,
"visibility": "public"
},
{
"name": "split",
"short_desc": "Split a string using a delim.",
"desc": "",
"params": [],
"returns": [],
"usage": "",
"is_virtual": false,
"is_abstract": false,
"is_deprecated": false,
"is_static": false,
"visibility": "public"
}
],
"desc": "",
"usage": "",
"inherits_from": [
"foo.Base"
],
"fields": []
}
],
"functions": [],
"data": [],
"name": "unknown",
"is_class_mod": false,
"short_desc": "",
"desc": "",
"usage": ""
}
Many other examples can be seen in luadoc/tests/source.
Metadata
Release files for luadoc 1.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| luadoc-1.4.1.tar.gz | 31.8 kB | Without provenance | Details for luadoc-1.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| luadoc-1.4.1-py3-none-any.whl | Python 3 | none | any | Details for luadoc-1.4.1-py3-none-any.whl |
Total release size: 64.9 kB
Release files / luadoc-1.4.1.tar.gz
| Download URL | luadoc-1.4.1.tar.gz |
|---|---|
| Size | 31.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d087d9515b8bf9fda48b3ab4a8002df06da0a2d62d267085575d3d6344bf846
|
|
BLAKE2b-256 checksum How to use checksums |
bfbf155c7567800ff72ad21ea447d98eca1a9d1e186ac4bffdc2995bcd31b067
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / luadoc-1.4.1-py3-none-any.whl
| Download URL | luadoc-1.4.1-py3-none-any.whl |
|---|---|
| Size | 33.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
30731a2bca0ebc420d5a4648072f45f4c9c09c8155d2ce26d47a01e3fa69d784
|
|
BLAKE2b-256 checksum How to use checksums |
2927ff4831913ec883a1685ac80325b43da566b1eb8c5d3927caba522e516d96
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for luadoc 1.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.