sphinxcontrib-luadomain 1.1.2

Sphinx domain for documenting Lua code

A sphinx lua domain.

Installation

$ pip install sphinxcontrib-luadomain

Sphinx integration

Add the following to your conf.py:

extensions = ['sphinxcontrib.luadomain']

Available sphinx directives

The following directives are available:

Documenting class

.. lua:class:: pl.List

    Python-style list class.

    .. lua:attribute:: size: number

        The list size.

    .. lua:method:: append(elem)

        :param elem: The element to append
        :type elem: any

    .. lua:staticmethod:: fromArray(a): pl.List

        Create a List from a raw array.

        :return: The new List
        :rtype: pl.List

Class handle inheritance:

.. lua:class:: ITransport

    .. lua:method:: startEngine(): boolean
        :virtual:

        :return: true if engine started
        :rtype: boolean

.. lua:class:: Car: ITransport

    .. lua:method:: startEngine(): boolean

        :return: true if engine started
        :rtype: boolean

Method modifiers

.. lua:method:: foo()
    :virtual:
    :abstract:
    :deprecated:
    :protected:

    Show method modifiers.

Documenting module

.. lua:module:: pl.path

.. lua:function:: join(p1, p2)

    Return the path resulting from combining the individual paths.

    :param p1: First path
    :type p1: str
    :param p2: An other path
    :type p2: str
    :return: The combined path
    :rtype: str

Type alias

.. lua:alias:: Packet = table<string, number>

   A packet.


.. lua:class:: MessageSender

    A message sender.

    .. lua:method:: send(packet)
        :abstract:

        An abstract method.

        :param packet: the packet to send
        :type packet: Packet

Cross-references

:lua:class:`pl.List`

:lua:meth:`pl.List.append`