Skip to main content

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
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-luadomain, version 1.1.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-luadomain-1.1.1.tar.gz (10.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page