sphinx-lua-ls 3.1.0__tar.gz → 3.3.0__tar.gz

sphinx_lua_ls-3.3.0/.github/dependabot.yml

@@ -0,0 +1,26 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      dev:
+        patterns:
+          - "beautifulsoup4"
+          - "furo"
+          - "myst-parser"
+          - "pyright"
+          - "pytest_image_diff"
+          - "pytest-cov"
+          - "pytest-regressions"
+          - "pytest"
+          - "reportlab"
+          - "sphinx_design"
+          - "svglib"
+          - "sybil"
+      style:
+        patterns:
+          - "black"
+          - "isort"
+          - "pre-commit"

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/.github/workflows/ci.yaml

@@ -23,6 +23,8 @@ jobs:
     steps:
       - name: Checkout source
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
@@ -79,6 +81,8 @@ jobs:
     steps:
       - name: Checkout source
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
@@ -88,7 +92,7 @@ jobs:
       # Tests
       - name: Install test dependencies
         if: ${{ matrix.type == 'test' }}
-        run: python -m pip install '.[test]'
+        run: python -m pip install . --group test
       - name: Download LuaLs
         if: ${{ matrix.type == 'test' }}
         uses: actions/download-artifact@v4
@@ -106,7 +110,7 @@ jobs:
       # Lint
       - name: Install lint dependencies
         if: ${{ matrix.type == 'code style' }}
-        run: python -m pip install '.[lint]'
+        run: python -m pip install . --group lint
       - name: Check code style
         if: ${{ matrix.type == 'code style' }}
         run: pre-commit run -a
@@ -124,10 +128,26 @@ jobs:
       name: pypi
       url: https://pypi.org/p/sphinx-lua-ls
     permissions:
+      contents: write
       id-token: write
     steps:
       - name: Checkout source
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Generate release metadata
+        id: metadata
+        run: |
+          ref="${{ github.ref }}";
+          version=${ref#refs/tags/v};
+          link="https://pypi.org/p/${{ github.repository }}/${version}";
+          echo "version=${version}" >> $GITHUB_OUTPUT
+          echo "link=${link}" >> $GITHUB_OUTPUT
+      - name: Parse Changelog
+        id: changelog
+        uses: mindsers/changelog-reader-action@v2
+        with:
+          version: ${{ steps.metadata.outputs.version }}
       - name: Set up python 3.12
         uses: actions/setup-python@v4
         with:
@@ -147,6 +167,17 @@ jobs:
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           attestations: false
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          prerelease: ${{ steps.changelog.outputs.status == 'prereleased' }}
+          draft: ${{ steps.changelog.outputs.status == 'unreleased' }}
+          body: |
+            ## Changelog
+
+            ${{ steps.changelog.outputs.changes }}
+
+            [See release on PyPi](${{ steps.metadata.outputs.link }})
 
   # Builds sphinx documentation.
   #
@@ -155,11 +186,13 @@ jobs:
     name: Build docs
     needs:
       - test
-    if: ${{ !(github.event_name == 'pull_request' && github.event.action == 'closed') }}
+    if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') && !contains(github.event.ref, '.dev') }}
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Set up python 3.12
         uses: actions/setup-python@v4
         with:
@@ -167,7 +200,7 @@ jobs:
       - name: Install package
         run: |
           python -m pip install --upgrade pip
-          python -m pip install '.[doc]'
+          python -m pip install . --group doc
       - name: Download LuaLs
         uses: actions/download-artifact@v4
         with:
@@ -175,7 +208,7 @@ jobs:
           path: ~/lua_ls_release
       - name: Build docs
         env:
-          SPHINXOPTS: "-j auto"
+          SPHINXOPTS: "-j auto -n"
           LUA_LS_CACHE_PATH: ~/lua_ls_release/ubuntu-latest
         run: |
           cd docs
@@ -187,38 +220,6 @@ jobs:
           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.
@@ -235,6 +236,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Download artifact
         uses: actions/download-artifact@v4
         with:

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/.pre-commit-config.yaml

@@ -5,28 +5,22 @@ repos:
         name: black
         language: system
         entry: black
-        types: [python]
-        files: ^(?!docs)
+        types_or: [python, pyi]
         require_serial: true
       - id: isort
         name: isort
         language: system
-        entry: isort
-        types: [python]
-        files: ^(?!docs)
+        entry: isort --filter-files
+        types_or: [python, pyi]
         require_serial: true
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v6.0.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

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/CHANGELOG.md

@@ -1,6 +1,41 @@
 # Changelog
 
-## v3.1.0
+## [unreleased]
+
+## [3.3.0]
+
+- Added an option to extend list options (like `:exclude-members:`) without overriding
+  defaults:
+
+  ```rst
+  .. lua:autoobject::
+     :exclude-members: +foo
+  ```
+
+  Also added `:no-*:` options to ignore defaults.
+
+- Improved display of members which use types instead of names,
+  i.e. `[<type>]` ([#19] by [@bkoropoff]).
+
+- Added a warning for situations when `lua_ls_project_directories` contains directories
+  outside of the current VCS root.
+
+[#19]: https://github.com/taminomara/sphinx-lua-ls/pull/19
+
+## [3.2.0]
+
+- Updated a few dependencies. Most notably, restricted `sphinx` to `<9`.
+
+- Fixed dashes in types being parsed as type names ([#18] by [@bkoropoff]).
+
+- Added normalization for function syntax (`fun() -> T` is converted to `fun(): T`).
+
+- Done some internal refactorings.
+
+[#18]: https://github.com/taminomara/sphinx-lua-ls/pull/18
+[@bkoropoff]: https://github.com/bkoropoff
+
+## [3.1.0]
 
 - Added pygments lexer for Lua that highlights documentation tags.
 
@@ -13,7 +48,7 @@
 
 - Fixed some edge cases in parsing of type expressions.
 
-## v3.0.0
+## [3.0.0]
 
 - **Breaking change:** changed how `apidoc` generates file names to avoid collisions.
 
@@ -81,18 +116,18 @@
 [EmmyLua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
 [#3]: https://github.com/taminomara/sphinx-lua-ls/issues/3
 
-**Migrating to 3.0.0:**
+### Migrating to 3.0.0
 
 - If you're using `apidoc`, you'll need to update links to your documentation.
 
 - You'll need to explicitly specify which language server to use
   by including `lua_ls_backend` to your `conf.py`.
 
-## v2.0.1
+## [2.0.1]
 
 - Fixed documentation not being rebuilt after changing lua source code.
 
-## v2.0.0
+## [2.0.0]
 
 - **Breaking change:** don't implicitly convert classes that're derived from `table`
   to modules. Users should use a `!doctype` comment instead.
@@ -105,7 +140,7 @@
 
 - Improved test coverage and fixed found bugs.
 
-**Migrating to 2.0.0:**
+### Migrating to 2.0.0
 
 In your Lua code base, perform global replace by regexp:
 
@@ -124,7 +159,7 @@ Make sure that you only use `!doctype module` on the top-level
 tables that can be imported via `require`. On other objects,
 use `!doctype table` instead, otherwise you'll get errors that modules are not allowed within other objects.
 
-## v1.1.0
+## [1.1.0]
 
 - Added support for `!doc` and `!doctype` comments.
 
@@ -143,6 +178,16 @@ use `!doctype table` instead, otherwise you'll get errors that modules are not a
 
 - Fixed types when `lua:autoobject` would infer incorrect types for `data`.
 
-## v1.0.0
+## [1.0.0]
 
 Initial release.
+
+[unreleased]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.3.0...HEAD
+[3.3.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.2.0...v3.3.0
+[3.2.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.1.0...v3.2.0
+[3.1.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.0.0...v3.1.0
+[3.0.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v2.0.1...v3.0.0
+[2.0.1]: https://github.com/taminomara/sphinx-lua-ls/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v1.1.0...v2.0.0
+[1.1.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/taminomara/sphinx-lua-ls/releases/tag/v1.0.0

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/CONTRIBUTING.md

@@ -13,7 +13,7 @@
 3. Install Sphinx-LuaLs in development mode, and install dev dependencies:
 
    ```shell
-   pip install -e .[dev]
+   pip install -e . --group dev
    ```
 
 4. Install pre-commit hooks:

{sphinx_lua_ls-3.1.0/sphinx_lua_ls.egg-info → sphinx_lua_ls-3.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.1.0
+Version: 3.3.0
 Summary: Automatic documentation generation via EmmyLua/LuaLs
 Author-email: Tamika Nomara <taminomara@gmail.com>
 License-Expression: MIT
@@ -24,28 +24,9 @@ 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: sphinx<9.0,>=8.0
+Requires-Dist: PyGithub<3.0,>=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
@@ -58,9 +39,9 @@ Document Lua projects using Lua Language Server's output. This plugin features:
 ## 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)
+- [Installation](https://taminomara.github.io/sphinx-lua-ls/installation.html)
+- [Quickstart](https://taminomara.github.io/sphinx-lua-ls/quickstart.html)
+- [Example output](https://taminomara.github.io/sphinx-lua-ls/example.html)
 
 ## Requirements
 

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/README.md

@@ -8,9 +8,9 @@ Document Lua projects using Lua Language Server's output. This plugin features:
 ## 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)
+- [Installation](https://taminomara.github.io/sphinx-lua-ls/installation.html)
+- [Quickstart](https://taminomara.github.io/sphinx-lua-ls/quickstart.html)
+- [Example output](https://taminomara.github.io/sphinx-lua-ls/example.html)
 
 ## Requirements
 

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=
+SPHINXOPTS    ?= -j auto -n
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/docs/source/autodoc.rst

@@ -293,19 +293,14 @@ Autodoc directive
       for all objects nested within the root. That is, object's members,
       their members, and so on.
 
-      If
-      :rst:dir:`lua:autoobject:members`,
-      :rst:dir:`lua:autoobject:globals`,
-      :rst:dir:`lua:autoobject:undoc-members`,
-      :rst:dir:`lua:autoobject:private-members`,
-      :rst:dir:`lua:autoobject:special-members`,
-      or :rst:dir:`lua:autoobject:inherited-members`
-      are given as flags, they are propagated to all documented objects.
-
-      If they're given as list, they are not propagated.
-
-      Options from :py:data:`lua_ls_default_options` are applied to all recursively
-      documented objects.
+      Options like ``no-index`` or :rst:dir:`lua:autoobject:member-order` are always
+      passed down to all members.
+
+      List options like :rst:dir:`lua:autoobject:members`
+      or :rst:dir:`lua:autoobject:globals`
+      are passed down if they're empty or start with ``+``
+      (see :py:data:`lua_ls_default_options` for info on ``+``
+      and overriding defaults).
 
    .. rst:directive:option:: member-order
 

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/docs/source/example.rst

@@ -31,15 +31,18 @@ This output is generated with the following directive:
          :module-member-order: groupwise
          ```
 
-See ``logging.lua`` `on github`_.
+.. tab-set::
+
+   .. tab-item:: Result
 
-.. _on github: https://github.com/taminomara/sphinx-lua-ls/blob/main/docs/example/logging.lua
+      .. lua:autoobject:: logging
+         :members:
+         :globals:
+         :recursive:
+         :index-table:
+         :module-member-order: groupwise
 
-----
+   .. tab-item:: logging.lua
 
-.. lua:autoobject:: logging
-   :members:
-   :globals:
-   :recursive:
-   :index-table:
-   :module-member-order: groupwise
+      .. literalinclude:: /example/logging.lua
+         :language: lua

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/docs/source/index.rst

@@ -22,9 +22,8 @@ See an example output: `logging`.
    settings
    example
 
+.. toctree::
+    :hidden:
+    :caption: Links
 
-Indices and tables
-------------------
-
-* :ref:`genindex`
-* :ref:`search`
+    GitHub <https://github.com/taminomara/sphinx-lua-ls/>

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/docs/source/roles.rst

@@ -6,7 +6,7 @@ Cross-referencing objects
 
    You can reference any documented object through the :rst:role:`lua:obj` role.
 
-   Given an object path, Lua domain will first search for an object with this path
+   Given an object path, Sphinx-LuaLs will first search for an object with this path
    in the outer-most class, then in the current module, and finally
    in the global namespace.
 
@@ -18,7 +18,6 @@ Cross-referencing objects
    If you specify a fully qualified object name, and would like to hide its prefix,
    you can add a tilde (``~``) to the object's path:
 
-
    .. tab-set::
       :sync-group: lang
 

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/docs/source/settings.rst

@@ -56,6 +56,25 @@ Settings
           # And so on...
       }
 
+   If using defaults for the ``:members:``, ``:exclude-members:``, and other
+   list options, setting the option on a directive will override the default.
+   Instead, to extend the default list with the per-directive option,
+   the list may be prepended with a plus sign (``+``), as follows:
+
+   .. code-block:: rst
+
+      .. lua:autoobject:: Noodle
+         :members: eat
+         :private-members: +_spicy, _garlickly
+
+   Also, the defaults can be disabled per-directive with the negated form,
+   ``:no-option:`` as an option of the directive:
+
+   .. code-block:: rst
+
+      .. lua:autoobject:: foo
+         :no-undoc-members:
+
 .. py:data:: class_default_function_name
    :type: str
 

{sphinx_lua_ls-3.1.0 → sphinx_lua_ls-3.3.0}/pyproject.toml

@@ -22,34 +22,36 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "sphinx>=8.0",
-    "PyGithub~=1.59",
+    "sphinx>=8.0,<9.0",
+    "PyGithub>=1.59,<3.0",
     "requests~=2.31",
 ]
 
-[project.optional-dependencies]
+[dependency-groups]
 dev = [
-    "pytest-cov~=6.0.0",
-    "sphinx-lua-ls[test,lint,doc]",
+    "pytest-cov==7.0.0",
+    {include-group = "test"},
+    {include-group = "lint"},
+    {include-group = "doc"},
 ]
 lint = [
-    "black~=23.7",
-    "isort~=5.12",
-    "pre-commit~=3.8.0",
+    "black==25.9.0",
+    "isort==6.0.1",
+    "pre-commit==4.3.0",
 ]
 test = [
-    "pyright~=1.1",
-    "pytest~=7.4",
-    "sybil~=6.1",
-    "pytest-regressions~=2.7",
-    "beautifulsoup4~=4.13",
-    "myst-parser~=4.0"
+    "pyright==1.1.405",
+    "pytest==8.4.2",
+    "sybil==9.2.0",
+    "pytest-regressions==2.8.3",
+    "beautifulsoup4==4.14.0",
+    "myst-parser==4.0.1"
 ]
 doc = [
-    "sybil~=6.1",
-    "furo>=2024",
-    "sphinx_design>=0.6",
-    "myst-parser~=4.0"
+    "sybil==9.2.0",
+    "furo==2025.9.25",
+    "sphinx_design==0.6.1",
+    "myst-parser==4.0.1"
 ]
 
 [project.urls]
@@ -90,10 +92,6 @@ reportUnnecessaryIsInstance = "none"
 reportConstantRedefinition = "none"
 reportRedeclaration = "none"
 
-[tool.black]
-extend-exclude = '^/docs'
-
 [tool.isort]
 profile = "black"
-extend_skip_glob = ["docs/*"]
 skip_gitignore = true