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-luaSphinx 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.0.tar.gz
(7.5 kB
view details)
File details
Details for the file sphinx-lua-1.1.0.tar.gz.
File metadata
- Download URL: sphinx-lua-1.1.0.tar.gz
- Upload date:
- Size: 7.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
777c14dbb4db5523a1f2be660f38e12f0a7de78d5be4c66c81d40d54c7460a2d
|
|
| MD5 |
f50f0a6c0874986f88554ae239950316
|
|
| BLAKE2b-256 |
a759ae3d3a54d8e5167de4af2e584f1ee2d991b73cfeb976737d769a0e9f8491
|
