Metadata-Version: 2.4
Name: sphinx-lua-ls
Version: 3.1.0
Summary: Automatic documentation generation via EmmyLua/LuaLs
Author-email: Tamika Nomara <taminomara@gmail.com>
License-Expression: MIT
Project-URL: Documentation, https://taminomara.github.io/sphinx-lua-ls/
Project-URL: Issues, https://github.com/taminomara/sphinx-lua-ls/issues
Project-URL: Source, https://github.com/taminomara/sphinx-lua-ls/
Project-URL: Changelog, https://github.com/taminomara/sphinx-lua-ls/blob/main/CHANGELOG.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Intended Audience :: Developers
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Domain
Classifier: Framework :: Sphinx :: Extension
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Typing :: Typed
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sphinx>=8.0
Requires-Dist: PyGithub~=1.59
Requires-Dist: requests~=2.31
Provides-Extra: dev
Requires-Dist: pytest-cov~=6.0.0; extra == "dev"
Requires-Dist: sphinx-lua-ls[doc,lint,test]; extra == "dev"
Provides-Extra: lint
Requires-Dist: black~=23.7; extra == "lint"
Requires-Dist: isort~=5.12; extra == "lint"
Requires-Dist: pre-commit~=3.8.0; extra == "lint"
Provides-Extra: test
Requires-Dist: pyright~=1.1; extra == "test"
Requires-Dist: pytest~=7.4; extra == "test"
Requires-Dist: sybil~=6.1; extra == "test"
Requires-Dist: pytest-regressions~=2.7; extra == "test"
Requires-Dist: beautifulsoup4~=4.13; extra == "test"
Requires-Dist: myst-parser~=4.0; extra == "test"
Provides-Extra: doc
Requires-Dist: sybil~=6.1; extra == "doc"
Requires-Dist: furo>=2024; extra == "doc"
Requires-Dist: sphinx_design>=0.6; extra == "doc"
Requires-Dist: myst-parser~=4.0; extra == "doc"
Dynamic: license-file

# Sphinx plugin for Lua and Lua Language Server

Document Lua projects using Lua Language Server's output. This plugin features:

- new domain for Lua language,
- directives to automatically generate documentation based on source code.

## Resources

- [Documentation](https://taminomara.github.io/sphinx-lua-ls/)
- [Installation](https://taminomara.github.io/sphinx-lua-ls/#installation)
- [Quickstart](https://taminomara.github.io/sphinx-lua-ls/#quickstart)
- [Example output](https://taminomara.github.io/sphinx-lua-ls/#example-output)

## Requirements

- python >= 3.12
- sphinx >= 8.0

## Installation

```sh
pip install sphinx-lua-ls
```
