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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37a6c5b5f22952652f889aa31b9ab8ce5aa4b4937ecc7a12a599c41bea6bd786 |
|
MD5 | 59f2c8e788031128085819fa10459fc7 |
|
BLAKE2b-256 | 82ee1a2705a9d398ae9308bde26bf1421524f00f124ee3193f00435c3564f2ca |