sphinx-lua-ls 3.5.0__tar.gz → 3.5.0.post1__tar.gz

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/.github/workflows/ci.yaml

@@ -8,17 +8,9 @@ on:
   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
@@ -52,15 +44,10 @@ jobs:
           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:
@@ -114,10 +101,6 @@ jobs:
       - 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:
@@ -140,7 +123,7 @@ jobs:
         run: |
           ref="${{ github.ref }}";
           version=${ref#refs/tags/v};
-          link="https://pypi.org/p/${{ github.repository }}/${version}";
+          link="https://pypi.org/p/sphinx-lua-ls/${version}";
           echo "version=${version}" >> $GITHUB_OUTPUT
           echo "link=${link}" >> $GITHUB_OUTPUT
       - name: Parse Changelog
@@ -178,75 +161,3 @@ jobs:
             ${{ steps.changelog.outputs.changes }}
 
             [See release on PyPi](${{ steps.metadata.outputs.link }})
-
-  # Builds sphinx documentation.
-  #
-  # Runs on all events except when closing a pull request.
-  build_docs:
-    name: Build docs
-    needs:
-      - test
-    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:
-          python-version: 3.12
-      - name: Install package
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install . --group 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 -n"
-          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
-
-  # 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
-        with:
-          fetch-depth: 0
-      - 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-3.5.0.post1/.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+  jobs:
+    post_checkout:
+      - git fetch --unshallow || true
+    install:
+      - pip install -U pip
+      - pip install . --group doc
+sphinx:
+   configuration: docs/source/conf.py

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [unreleased]
 
+## [3.5.0-post1]
+
+- Migrated documentation to Read the Docs.
+
+- Moved repository to [sphinx-contrib](https://github.com/sphinx-contrib) organization.
+
 ## [3.5.0]
 
 - Added `autodata`, `autoattribute`, `autoclass`, and other `auto*` directives.
@@ -53,7 +59,7 @@
 - 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
+[#19]: https://github.com/sphinx-contrib/lua-ls/pull/19
 
 ## [3.2.0]
 
@@ -65,7 +71,7 @@
 
 - Done some internal refactorings.
 
-[#18]: https://github.com/taminomara/sphinx-lua-ls/pull/18
+[#18]: https://github.com/sphinx-contrib/lua-ls/pull/18
 [@bkoropoff]: https://github.com/bkoropoff
 
 ## [3.1.0]
@@ -147,7 +153,7 @@
 - Added option to separate module members into their own files for `apidoc`.
 
 [EmmyLua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
-[#3]: https://github.com/taminomara/sphinx-lua-ls/issues/3
+[#3]: https://github.com/sphinx-contrib/lua-ls/issues/3
 
 ### Migrating to 3.0.0
 
@@ -215,14 +221,15 @@ use `!doctype table` instead, otherwise you'll get errors that modules are not a
 
 Initial release.
 
-[unreleased]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.5.0...HEAD
-[3.5.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.4.0...v3.5.0
-[3.4.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.3.0...v3.4.0
-[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
+[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0-post1...HEAD
+[3.5.0-post1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0...v3.5.0-post1
+[3.5.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.4.0...v3.5.0
+[3.4.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.3.0...v3.4.0
+[3.3.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.2.0...v3.3.0
+[3.2.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.1.0...v3.2.0
+[3.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.0.0...v3.1.0
+[3.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.1...v3.0.0
+[2.0.1]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v1.1.0...v2.0.0
+[1.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/sphinx-contrib/lua-ls/releases/tag/v1.0.0

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/CONTRIBUTING.md

@@ -2,11 +2,7 @@
 
 ## Set up your environment
 
-1. Check out the repo:
-
-   ```shell
-   git clone git@github.com:taminomara/sphinx-lua-ls.git
-   ```
+1. Clone the repository.
 
 2. Create a virtual environment with python `3.12` or newer.
 
@@ -58,3 +54,20 @@ make html
 ```
 
 Sphinx-LuaLs will download the latest version of Lua Language Server for you.
+
+
+## Release
+
+1. Update `changelog.md`. Make sure to update links at the end of the file.
+
+   Changelog *must* have a section for the new release, otherwise the build
+   will fail.
+
+2. Push a git tag. You'll need a repository admin role to do so.
+
+   All tags should start with prefix `v`, and follow semantic versioning guidelines.
+   This, among other things, means that tags for beta-, post-, etc. releases
+   should have form `v1.0.0-beta0` instead of Python's `v1.0.0b0`.
+
+3. From here, release happens automatically. PyPi package will be uploaded from
+   CI job, and documentation will be updated by Read the Docs build.

{sphinx_lua_ls-3.5.0/sphinx_lua_ls.egg-info → sphinx_lua_ls-3.5.0.post1}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.5.0
+Version: 3.5.0.post1
 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
+Project-URL: Documentation, https://sphinx-lua-ls.readthedocs.io/en/stable/
+Project-URL: Issues, https://github.com/sphinx-contrib/lua-ls/issues
+Project-URL: Source, https://github.com/sphinx-contrib/lua-ls/
+Project-URL: Changelog, https://github.com/sphinx-contrib/lua-ls/blob/main/CHANGELOG.md
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3
@@ -38,10 +38,10 @@ 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.html)
-- [Quickstart](https://taminomara.github.io/sphinx-lua-ls/quickstart.html)
-- [Example output](https://taminomara.github.io/sphinx-lua-ls/example.html)
+- [Documentation](https://sphinx-lua-ls.readthedocs.io/en/stable/)
+- [Installation](https://sphinx-lua-ls.readthedocs.io/en/stable/installation.html)
+- [Quickstart](https://sphinx-lua-ls.readthedocs.io/en/stable/quickstart.html)
+- [Example output](https://sphinx-lua-ls.readthedocs.io/en/stable/example.html)
 
 ## Requirements
 

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/README.md

@@ -7,10 +7,10 @@ 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.html)
-- [Quickstart](https://taminomara.github.io/sphinx-lua-ls/quickstart.html)
-- [Example output](https://taminomara.github.io/sphinx-lua-ls/example.html)
+- [Documentation](https://sphinx-lua-ls.readthedocs.io/en/stable/)
+- [Installation](https://sphinx-lua-ls.readthedocs.io/en/stable/installation.html)
+- [Quickstart](https://sphinx-lua-ls.readthedocs.io/en/stable/quickstart.html)
+- [Example output](https://sphinx-lua-ls.readthedocs.io/en/stable/example.html)
 
 ## Requirements
 

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/conf.py

@@ -38,7 +38,7 @@ intersphinx_mapping = {
 html_theme = "furo"
 html_extra_path = ["_extra/robots.txt"]
 html_theme_options = {
-    "source_repository": "https://github.com/taminomara/sphinx-lua-ls",
+    "source_repository": "https://github.com/sphinx-contrib/lua-ls",
     "source_branch": "main",
     "source_directory": "docs/source",
 }

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/index.rst

@@ -26,4 +26,4 @@ See an example output: `logging`.
     :hidden:
     :caption: Links
 
-    GitHub <https://github.com/taminomara/sphinx-lua-ls/>
+    GitHub <https://github.com/sphinx-contrib/lua-ls/>

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/pyproject.toml

@@ -44,7 +44,7 @@ test = [
     "pytest==8.4.2",
     "sybil==9.2.0",
     "pytest-regressions==2.8.3",
-    "beautifulsoup4==4.14.0",
+    "beautifulsoup4==4.14.2",
     "myst-parser==4.0.1"
 ]
 doc = [
@@ -55,10 +55,10 @@ doc = [
 ]
 
 [project.urls]
-Documentation = "https://taminomara.github.io/sphinx-lua-ls/"
-Issues = "https://github.com/taminomara/sphinx-lua-ls/issues"
-Source = "https://github.com/taminomara/sphinx-lua-ls/"
-Changelog = "https://github.com/taminomara/sphinx-lua-ls/blob/main/CHANGELOG.md"
+Documentation = "https://sphinx-lua-ls.readthedocs.io/en/stable/"
+Issues = "https://github.com/sphinx-contrib/lua-ls/issues"
+Source = "https://github.com/sphinx-contrib/lua-ls/"
+Changelog = "https://github.com/sphinx-contrib/lua-ls/blob/main/CHANGELOG.md"
 
 [build-system]
 requires = ["setuptools>=60", "setuptools_scm[toml]>=8", "wheel>=0.40"]

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.5.0'
-__version_tuple__ = version_tuple = (3, 5, 0)
+__version__ = version = '3.5.0.post1'
+__version_tuple__ = version_tuple = (3, 5, 0, 'post1')
 
-__commit_id__ = commit_id = 'ga93dbf791'
+__commit_id__ = commit_id = 'g2fb45db04'

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/apidoc.py

@@ -109,7 +109,7 @@ def generate(
         msg = (
             "Running Lua apidoc on case-insensitive file system."
             "\nIf you experience issues, see documentation for potential solutions:"
-            "\n    https://taminomara.github.io/sphinx-lua-ls/settings.html#lua_ls_apidoc_separate_members"
+            "\n    https://sphinx-lua-ls.readthedocs.io/en/stable/settings.html#lua_ls_apidoc_separate_members"
         )
         if sys.platform == "win32" and is_case_insensitive:
             msg += (

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/lua_ls.py

@@ -330,6 +330,8 @@ def resolve(
         path where LuaLs binaries should be downloaded to.
     :param min_version:
         minimal LuaLs version required.
+    :param max_version:
+        maximal LuaLs version required. Version is not limited is `None`.
     :param quiet:
         if true (default), any output from the LuaLs binary is hidden.
     :param env:

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1/sphinx_lua_ls.egg-info}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.5.0
+Version: 3.5.0.post1
 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
+Project-URL: Documentation, https://sphinx-lua-ls.readthedocs.io/en/stable/
+Project-URL: Issues, https://github.com/sphinx-contrib/lua-ls/issues
+Project-URL: Source, https://github.com/sphinx-contrib/lua-ls/
+Project-URL: Changelog, https://github.com/sphinx-contrib/lua-ls/blob/main/CHANGELOG.md
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3
@@ -38,10 +38,10 @@ 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.html)
-- [Quickstart](https://taminomara.github.io/sphinx-lua-ls/quickstart.html)
-- [Example output](https://taminomara.github.io/sphinx-lua-ls/example.html)
+- [Documentation](https://sphinx-lua-ls.readthedocs.io/en/stable/)
+- [Installation](https://sphinx-lua-ls.readthedocs.io/en/stable/installation.html)
+- [Quickstart](https://sphinx-lua-ls.readthedocs.io/en/stable/quickstart.html)
+- [Example output](https://sphinx-lua-ls.readthedocs.io/en/stable/example.html)
 
 ## Requirements
 

{sphinx_lua_ls-3.5.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls.egg-info/SOURCES.txt

@@ -1,5 +1,6 @@
 .gitignore
 .pre-commit-config.yaml
+.readthedocs.yaml
 CHANGELOG.md
 CONTRIBUTING.md
 LICENSE