sphinx-lua-ls 0.0.4__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,92 @@
1
+ Metadata-Version: 2.2
2
+ Name: sphinx-lua-ls
3
+ Version: 0.0.4
4
+ Summary: Automatic documentation generation via LuaLS
5
+ Author-email: Tamika Nomara <taminomara@gmail.com>
6
+ License: MIT License
7
+
8
+ Copyright (c) 2018 Tamika Nomara
9
+
10
+ Permission is hereby granted, free of charge, to any person obtaining a copy
11
+ of this software and associated documentation files (the "Software"), to deal
12
+ in the Software without restriction, including without limitation the rights
13
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14
+ copies of the Software, and to permit persons to whom the Software is
15
+ furnished to do so, subject to the following conditions:
16
+
17
+ The above copyright notice and this permission notice shall be included in all
18
+ copies or substantial portions of the Software.
19
+
20
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26
+ SOFTWARE.
27
+
28
+ Project-URL: Documentation, https://taminomara.github.io/sphinx-lua-ls/
29
+ Project-URL: Issues, https://github.com/taminomara/sphinx-lua-ls/issues
30
+ Project-URL: Source, https://github.com/taminomara/sphinx-lua-ls/
31
+ Classifier: Development Status :: 5 - Production/Stable
32
+ Classifier: Programming Language :: Python :: 3 :: Only
33
+ Classifier: Programming Language :: Python :: 3
34
+ Classifier: Programming Language :: Python :: 3.12
35
+ Classifier: Programming Language :: Python :: 3.13
36
+ Classifier: License :: OSI Approved :: MIT License
37
+ Classifier: Intended Audience :: Developers
38
+ Classifier: Framework :: Sphinx
39
+ Classifier: Framework :: Sphinx :: Domain
40
+ Classifier: Framework :: Sphinx :: Extension
41
+ Classifier: Topic :: Software Development :: Documentation
42
+ Classifier: Topic :: Documentation
43
+ Classifier: Topic :: Documentation :: Sphinx
44
+ Classifier: Typing :: Typed
45
+ Requires-Python: >=3.12
46
+ Description-Content-Type: text/markdown
47
+ License-File: LICENSE
48
+ Requires-Dist: sphinx>=8.0
49
+ Requires-Dist: PyGithub~=1.59
50
+ Requires-Dist: requests~=2.31
51
+ Provides-Extra: dev
52
+ Requires-Dist: pytest-cov~=6.0.0; extra == "dev"
53
+ Requires-Dist: sphinx-lua-ls[doc,lint,test]; extra == "dev"
54
+ Provides-Extra: lint
55
+ Requires-Dist: black~=23.7; extra == "lint"
56
+ Requires-Dist: isort~=5.12; extra == "lint"
57
+ Requires-Dist: pre-commit~=3.8.0; extra == "lint"
58
+ Provides-Extra: test
59
+ Requires-Dist: pyright~=1.1; extra == "test"
60
+ Requires-Dist: pytest~=7.4; extra == "test"
61
+ Requires-Dist: sybil~=6.1; extra == "test"
62
+ Requires-Dist: pytest-regressions~=2.7; extra == "test"
63
+ Requires-Dist: beautifulsoup4~=4.13; extra == "test"
64
+ Provides-Extra: doc
65
+ Requires-Dist: sybil~=6.1; extra == "doc"
66
+ Requires-Dist: pydata-sphinx-theme>=0.15; extra == "doc"
67
+ Requires-Dist: sphinx_design>=0.6; extra == "doc"
68
+
69
+ # Sphinx plugin for Lua and Lua Language Server
70
+
71
+ Document Lua projects using Lua Language Server's output. This plugin features:
72
+
73
+ - new domain for Lua language,
74
+ - directives to automatically generate documentation based on source code.
75
+
76
+ ## Resources
77
+
78
+ - [Documentation](https://taminomara.github.io/sphinx-lua-ls/)
79
+ - [Installation](https://taminomara.github.io/sphinx-lua-ls/#installation)
80
+ - [Quickstart](https://taminomara.github.io/sphinx-lua-ls/#quickstart)
81
+ - [Example output](https://taminomara.github.io/sphinx-lua-ls/#example-output)
82
+
83
+ ## Requirements
84
+
85
+ - python >= 3.12
86
+ - sphinx >= 8.0
87
+
88
+ ## Installation
89
+
90
+ ```sh
91
+ pip install sphinx-lua-ls
92
+ ```
@@ -0,0 +1,13 @@
1
+ sphinx_lua_ls/__init__.py,sha256=grQZpMtTTQruZh0jNERUbGluD5CSz0Kuf2u8M7iNfoI,6445
2
+ sphinx_lua_ls/_version.py,sha256=EY1c6JeG6uVHQoQcoxYAagjmJgQQxJk7iQ23gAoevU4,511
3
+ sphinx_lua_ls/autodoc.py,sha256=wafx1k5ZLi8CSGCxWw9DBWNNtETBiieetty5ydUvfuU,22227
4
+ sphinx_lua_ls/doctree.py,sha256=_bmcAHEca4lxNzLINzKYGdHA6vMxBpTaqBvHu6B99Is,11763
5
+ sphinx_lua_ls/domain.py,sha256=uflinEQtr8C8dVt3Z8K1nOehmiv-1cKucbaePykwNpI,38451
6
+ sphinx_lua_ls/intersphinx.py,sha256=0ts1pPycipyea9KckRxHZW1tovKIp_UP6vqb607V40Y,7086
7
+ sphinx_lua_ls/lua_ls.py,sha256=uSztL7iFybTJi-j92sUC1OZncUNaFZScPpZH24aI6_s,20484
8
+ sphinx_lua_ls/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
9
+ sphinx_lua_ls-0.0.4.dist-info/LICENSE,sha256=YGUN1Ht_F1SQ7RVPZCEjnviKjicvJ3GWdRXYgdHFRSM,1070
10
+ sphinx_lua_ls-0.0.4.dist-info/METADATA,sha256=gxqiew0ZOauKuLT3YZw9LQK3NoZL8HokdDxskZuFCyM,3800
11
+ sphinx_lua_ls-0.0.4.dist-info/WHEEL,sha256=EaM1zKIUYa7rQnxGiOCGhzJABRwy4WO57rWMR3_tj4I,91
12
+ sphinx_lua_ls-0.0.4.dist-info/top_level.txt,sha256=tUWPSW_Ct2MrczoHpb6w2zI7dUxbIl9D0fGiCCiG28Q,14
13
+ sphinx_lua_ls-0.0.4.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (75.9.1)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1 @@
1
+ sphinx_lua_ls