Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boolangery/py-lua-doc
A Lua documentation tool.
https://github.com/boolangery/py-lua-doc
doc generator lua
Last synced: about 1 month ago
JSON representation
A Lua documentation tool.
- Host: GitHub
- URL: https://github.com/boolangery/py-lua-doc
- Owner: boolangery
- License: gpl-3.0
- Created: 2018-07-05T15:04:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-01T18:29:54.000Z (about 1 year ago)
- Last Synced: 2024-09-29T15:23:04.047Z (about 2 months ago)
- Topics: doc, generator, lua
- Language: Python
- Size: 199 KB
- Stars: 18
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
py-lua-doc
----------
[](https://travis-ci.org/boolangery/py-lua-doc)
[](https://pypi.python.org/pypi/luadoc/)
[](https://pypi.python.org/pypi/luadoc/)
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`:
```bash
$ pip3 install luadoc
```
It will install the shell command 'luadoc'.
How to generate documentation ?
-------------------------------
This project is part of a [Sphinx](http://www.sphinx-doc.org/en/master/) documentation plugin: [sphinx-lua](https://github.com/boolangery/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:
```lua
--- @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
```
```bash
$ luadoc source.lua
```
The following output will be produced:
```json
{
"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`.