{"id":16645573,"url":"https://github.com/boolangery/sphinx-luadomain","last_synced_at":"2025-07-21T13:34:21.578Z","repository":{"id":87084284,"uuid":"109303692","full_name":"boolangery/sphinx-luadomain","owner":"boolangery","description":"The sphinx Lua domain","archived":false,"fork":false,"pushed_at":"2020-05-04T16:54:09.000Z","size":30,"stargazers_count":5,"open_issues_count":3,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-11T16:41:29.419Z","etag":null,"topics":["docs","lua","sphinx-extension"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boolangery.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-02T18:30:20.000Z","updated_at":"2023-10-02T10:22:05.000Z","dependencies_parsed_at":"2023-03-04T17:45:18.826Z","dependency_job_id":null,"html_url":"https://github.com/boolangery/sphinx-luadomain","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/boolangery/sphinx-luadomain","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boolangery%2Fsphinx-luadomain","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boolangery%2Fsphinx-luadomain/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boolangery%2Fsphinx-luadomain/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boolangery%2Fsphinx-luadomain/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boolangery","download_url":"https://codeload.github.com/boolangery/sphinx-luadomain/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boolangery%2Fsphinx-luadomain/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264974071,"owners_count":23691665,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","lua","sphinx-extension"],"created_at":"2024-10-12T08:24:19.514Z","updated_at":"2025-07-21T13:34:21.564Z","avatar_url":"https://github.com/boolangery.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"###############################################################################\nsphinxcontrib-luadomain\n###############################################################################\n\n.. image:: https://img.shields.io/pypi/v/sphinxcontrib-luadomain.svg\n    :target: https://pypi.python.org/pypi/sphinxcontrib-luadomain/\n.. image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-luadomain.svg\n    :target: https://pypi.python.org/pypi/sphinxcontrib-luadomain/\n\nA sphinx lua domain.\n\n\nInstallation\n===============================================================================\n\n.. code-block:: bash\n\n    $ pip install sphinxcontrib-luadomain\n\n\nSphinx integration\n===============================================================================\n\nAdd the following to your conf.py:\n\n.. code-block:: python\n\n    extensions = ['sphinxcontrib.luadomain']\n\n\n\nAvailable sphinx directives\n===============================================================================\n\nThe following directives are available:\n\n\nDocumenting class\n-------------------------------------------------------------------------------\n\n.. code-block:: rst\n\n    .. lua:class:: pl.List\n\n        Python-style list class.\n\n        .. lua:attribute:: size: number\n\n            The list size.\n\n        .. lua:method:: append(elem)\n\n            :param elem: The element to append\n            :type elem: any\n\n        .. lua:staticmethod:: fromArray(a): pl.List\n\n            Create a List from a raw array.\n\n            :return: The new List\n            :rtype: pl.List\n\n\nClass handle inheritance:\n\n.. code-block:: rst\n\n    .. lua:class:: ITransport\n\n        .. lua:method:: startEngine(): boolean\n            :virtual:\n\n            :return: true if engine started\n            :rtype: boolean\n\n    .. lua:class:: Car: ITransport\n\n        .. lua:method:: startEngine(): boolean\n\n            :return: true if engine started\n            :rtype: boolean\n\n\nMethod modifiers\n-------------------------------------------------------------------------------\n\n.. code-block:: rst\n\n    .. lua:method:: foo()\n        :virtual:\n        :abstract:\n        :deprecated:\n        :protected:\n\n        Show method modifiers.\n\nDocumenting module\n-------------------------------------------------------------------------------\n\n.. code-block:: rst\n\n    .. lua:module:: pl.path\n\n    .. lua:function:: join(p1, p2)\n\n        Return the path resulting from combining the individual paths.\n\n        :param p1: First path\n        :type p1: str\n        :param p2: An other path\n        :type p2: str\n        :return: The combined path\n        :rtype: str\n\n\nType alias\n-------------------------------------------------------------------------------\n\n\n.. code-block:: rst\n\n    .. lua:alias:: Packet = table\u003cstring, number\u003e\n\n       A packet.\n\n\n    .. lua:class:: MessageSender\n\n        A message sender.\n\n        .. lua:method:: send(packet)\n            :abstract:\n\n            An abstract method.\n\n            :param packet: the packet to send\n            :type packet: Packet\n\n\nCross-references\n-------------------------------------------------------------------------------\n\n.. code-block:: rst\n\n    :lua:class:`pl.List`\n\n    :lua:meth:`pl.List.append`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboolangery%2Fsphinx-luadomain","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboolangery%2Fsphinx-luadomain","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboolangery%2Fsphinx-luadomain/lists"}