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.3.tar.gz
(7.6 kB
view details)
File details
Details for the file sphinx-lua-1.1.3.tar.gz.
File metadata
- Download URL: sphinx-lua-1.1.3.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: Python-urllib/3.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e703f8b1a19ef3c4f98b5db865b0c7c7638e96f387b9c79da9b36aa05659272
|
|
| MD5 |
d6da014b99492a166478d19bbf69ce53
|
|
| BLAKE2b-256 |
bb960447be10783c0be9b9000f3551679126bfc176a25d778b69729d8cfd16fe
|
