Sphinx domain for documenting Lua code
Project description
##########
sphinx-lua
##########
A sphinx lua domain.
Full example:
```rest
.. lua:alias:: Packet = table<string, number>
A type alias.
.. lua:class:: Base
A base class
.. lua:attribute:: clsName: string
The class name
.. lua:class:: Foo: Base
My super lua class.
.. lua:method:: append(i)
:virtual:
A virtual method.
:param i: Value to append
:type i: integer or None
.. lua:staticmethod:: static(i)
A static method.
.. lua:method:: send(packet)
:abstract:
An abstract method.
:param Packet packet: foo
.. py:function:: send(msg)
Send a message to a recipient
:param str packet: The person sending the message
:type packet: string
:return: the message id
:rtype: int
```
sphinx-lua
##########
A sphinx lua domain.
Full example:
```rest
.. lua:alias:: Packet = table<string, number>
A type alias.
.. lua:class:: Base
A base class
.. lua:attribute:: clsName: string
The class name
.. lua:class:: Foo: Base
My super lua class.
.. lua:method:: append(i)
:virtual:
A virtual method.
:param i: Value to append
:type i: integer or None
.. lua:staticmethod:: static(i)
A static method.
.. lua:method:: send(packet)
:abstract:
An abstract method.
:param Packet packet: foo
.. py:function:: send(msg)
Send a message to a recipient
:param str packet: The person sending the message
:type packet: string
:return: the message id
:rtype: int
```
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for sphinxcontrib-luadomain-1.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13be7bde7aab88c9b4c33c524c343b83455e68c28f574fa815ac30e0e8892d4c |
|
MD5 | 36b07a1859600b665f835d2f52dd3289 |
|
BLAKE2b-256 | 8502f9928160751c0db8faa1af55c14fbd26cb5cd9e1d5729cc0cfedf2235d77 |