Support for using Sphinx on Luadoc-documented Lua code
Project description
A lua-autodoc tool for Sphinx. Generate a beautiful sphinx doc using lua doc comment.
It use emmylua as primary doc syntax but it is also compatible with some ldoc tags.
Installation
$ pip install sphinx-lua
Sphinx integration
Add the following to your conf.py:
extensions = ['sphinx_lua']
Available sphinx directives
The following directives are available:
.. lua:autoclass:: pl.List .. lua:automodule:: pl.stringx
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx-lua-1.1.3.tar.gz
(7.6 kB
view hashes)