sphinx-lua-ls 0.0.4__tar.gz

sphinx_lua_ls-0.0.4/.github/workflows/ci.yaml

@@ -0,0 +1,243 @@
+name: Test package
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+  pull_request:
+    branches:
+      - main
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+
+jobs:
+  # Download LuaLs for all platforms all at once, to reduce total number of downloads.
+  prepare:
+    name: Download LuaLs
+    if: ${{ !(github.event_name == 'pull_request' && github.event.action == 'closed') }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+      - name: Set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - name: Update pip
+        run: python -m pip install --upgrade pip
+      - name: Install dependencies
+        run: python -m pip install '.'
+      - name: Download LuaLs for Linux
+        run: python sphinx_lua_ls/lua_ls.py linux x86_64 ~/lua_ls_release/ubuntu-latest
+      - name: Download LuaLs for Windows
+        run: python sphinx_lua_ls/lua_ls.py win32 amd64 ~/lua_ls_release/windows-latest
+      - name: Download LuaLs for MacOs
+        run: python sphinx_lua_ls/lua_ls.py darwin x86_64 ~/lua_ls_release/macos-latest
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: lua_ls_release
+          path: ~/lua_ls_release
+          include-hidden-files: true
+          retention-days: 3
+
+  # Runs main tests for the package.
+  #
+  # Runs on all events except when closing a pull request.
+  test:
+    name: Test package
+    needs:
+      - prepare
+    if: ${{ !(github.event_name == 'pull_request' && github.event.action == 'closed') }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        python-version:
+          - "3.12"
+          - "3.13"
+        type:
+          - test
+        include:
+          - os: ubuntu-latest
+            python-version: "3.13"
+            type: code style
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+      - name: Set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Update pip
+        run: python -m pip install --upgrade pip
+      # Tests
+      - name: Install test dependencies
+        if: ${{ matrix.type == 'test' }}
+        run: python -m pip install '.[test]'
+      - name: Download LuaLs
+        if: ${{ matrix.type == 'test' }}
+        uses: actions/download-artifact@v4
+        with:
+          name: lua_ls_release
+          path: ~/lua_ls_release
+      - name: Check types
+        if: ${{ matrix.type == 'test' }}
+        run: pyright
+      - name: Test package
+        if: ${{ matrix.type == 'test' }}
+        run: pytest -vv --showlocals --tb=short --color=yes --junit-xml=test-results.xml
+        env:
+          LUA_LS_CACHE_PATH: ~/lua_ls_release/${{ matrix.os }}
+      # Lint
+      - name: Install lint dependencies
+        if: ${{ matrix.type == 'code style' }}
+        run: python -m pip install '.[lint]'
+      - name: Check code style
+        if: ${{ matrix.type == 'code style' }}
+        run: pre-commit run -a
+
+  # Builds and publishes python packages.
+  #
+  # Only runs on tag pushes.
+  publish_to_pypi:
+    name: Publish package to PyPi
+    needs:
+      - test
+    if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }}
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sphinx-lua-ls
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+      - name: Set up python 3.12
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+      - name: Install build
+        run: |
+          pip install build
+      - name: Build project
+        run: |
+          python3 -m build .
+      - name: Publish to test pypi
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          attestations: false
+      - name: Publish to pypi
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          attestations: false
+
+  # Builds sphinx documentation.
+  #
+  # Runs on all events except when closing a pull request.
+  build_docs:
+    name: Build docs
+    needs:
+      - test
+    if: ${{ !(github.event_name == 'pull_request' && github.event.action == 'closed') }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up python 3.12
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12
+      - name: Install package
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install '.[doc]'
+      - name: Download LuaLs
+        uses: actions/download-artifact@v4
+        with:
+          name: lua_ls_release
+          path: ~/lua_ls_release
+      - name: Build docs
+        env:
+          SPHINXOPTS: "-j auto"
+          LUA_LS_CACHE_PATH: ~/lua_ls_release/ubuntu-latest
+        run: |
+          cd docs
+          make html
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: html_output
+          path: docs/build/html
+          include-hidden-files: true
+
+  # Publishes documentation preview and posts a comment to the initiating PR.
+  #
+  # This job runs on all pull request actions. If also runs when a pull request is closed,
+  # in this case it deletes the preview.
+  #
+  # Since the default condition -- `success()` -- only runs if all dependencies succeeded,
+  # we use `!failure() && !cancelled()`, which also runs when any dependencies were skipped.
+  publish_docs_preview:
+    name: Publish docs preview to GitHub Pages
+    needs:
+      - build_docs
+    if: ${{ !failure() && !cancelled() && github.event_name == 'pull_request' }}
+    concurrency:
+      group: publish-docs-${{ github.ref }}
+      cancel-in-progress: true
+    permissions: write-all
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Download artifact
+        if: ${{ needs.build_docs.result == 'success' }}  # only download docs if build wasn't skipped
+        uses: actions/download-artifact@v4
+        with:
+          name: html_output
+          path: docs/build/html
+      - name: Publish HTML
+        uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: docs/build/html
+          umbrella-dir: pr-preview
+
+  # Builds and publishes production docs.
+  #
+  # Only runs on tag pushes.
+  publish_docs:
+    name: Publish docs to GitHub Pages
+    needs:
+      - build_docs
+    if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') && !contains(github.event.ref, '.dev') }}
+    concurrency:
+      group: publish-docs-${{ github.ref }}
+      cancel-in-progress: true
+    permissions: write-all
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: html_output
+          path: docs/build/html
+      - name: Publish HTML
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: docs/build/html
+          target-folder: .
+          clean-exclude: pr-preview
+          single-commit: false

sphinx_lua_ls-0.0.4/.gitignore

@@ -0,0 +1,136 @@
+@staticmethod# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Project-specific
+_version.py
+
+# IDEs
+.idea/
+.vscode/

sphinx_lua_ls-0.0.4/.pre-commit-config.yaml

@@ -0,0 +1,38 @@
+repos:
+  - repo: local
+    hooks:
+      - id: black
+        name: black
+        language: system
+        entry: black
+        types: [python]
+        files: ^(?!docs)
+        require_serial: true
+      - id: isort
+        name: isort
+        language: system
+        entry: isort
+        types: [python]
+        files: ^(?!docs)
+        require_serial: true
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+        require_serial: true
+      - id: end-of-file-fixer
+        require_serial: true
+      - id: fix-byte-order-marker
+        require_serial: true
+      - id: mixed-line-ending
+        args: [--fix=lf]
+        require_serial: true
+      - id: check-added-large-files
+      - id: check-yaml
+      - id: check-toml
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: destroyed-symlinks
+      - id: check-vcs-permalinks

sphinx_lua_ls-0.0.4/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "jira-plugin.workingProject": ""
+}

sphinx_lua_ls-0.0.4/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to Sphinx-LuaLs
+
+## Set up your environment
+
+1. Check out the repo:
+
+   ```shell
+   git clone git@github.com:taminomara/sphinx-lua-ls.git
+   ```
+
+2. Create a virtual environment with python `3.12` or newer.
+
+3. Install Sphinx-LuaLs in development mode, and install dev dependencies:
+
+   ```shell
+   pip install -e .[dev]
+   ```
+
+4. Install pre-commit hooks:
+
+   ```shell
+   pre-commit install
+   ```
+
+## Run tests
+
+To run tests, simply run `pytest` and `pyright`:
+
+```shell
+pytest  # Run unit tests.
+pyright  # Run type check.
+```
+
+To fix code style, you can manually run pre-commit hooks:
+
+```shell
+pre-commit run -a  # Fix code style.
+```
+
+
+## Build docs
+
+Just run `sphinx` as usual, nothing special is required:
+
+```shell
+cd docs/
+make html
+```
+
+Sphinx-LuaLs will download the latest version of Lua Language Server for you.

sphinx_lua_ls-0.0.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Tamika Nomara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sphinx_lua_ls-0.0.4/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.2
+Name: sphinx-lua-ls
+Version: 0.0.4
+Summary: Automatic documentation generation via LuaLS
+Author-email: Tamika Nomara <taminomara@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2018 Tamika Nomara
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+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/
+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: License :: OSI Approved :: MIT License
+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"
+Provides-Extra: doc
+Requires-Dist: sybil~=6.1; extra == "doc"
+Requires-Dist: pydata-sphinx-theme>=0.15; extra == "doc"
+Requires-Dist: sphinx_design>=0.6; extra == "doc"
+
+# 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
+```

sphinx_lua_ls-0.0.4/README.md

@@ -0,0 +1,24 @@
+# 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
+```

sphinx_lua_ls-0.0.4/conftest.py

@@ -0,0 +1,17 @@
+import sys
+
+from sybil import Sybil
+from sybil.parsers.codeblock import PythonCodeBlockParser
+from sybil.parsers.doctest import DocTestParser
+from sybil.parsers.rest import SkipParser
+
+if sys.version_info >= (3, 10):
+    # Examples use the new typing syntax.
+    pytest_collect_file = Sybil(
+        parsers=[
+            DocTestParser(),
+            PythonCodeBlockParser(),
+            SkipParser(),
+        ],
+        patterns=["*.rst", "*.py"],
+    ).pytest()

sphinx_lua_ls-0.0.4/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)