Enable RTD integration

Author: taminomara

.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,56 +101,10 @@ jobs:
       - name: Check code style
         if: ${{ matrix.type == 'code style' }}
         run: pre-commit run -a
-
-  # 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 python packages.
-  #
-  # Only runs on tag pushes.
   publish_to_pypi:
     name: Publish package to PyPi
     needs:
       - test
-      - build_docs
     if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }}
     runs-on: ubuntu-latest
     environment:
@@ -182,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
@@ -220,35 +161,3 @@ jobs:
             ${{ steps.changelog.outputs.changes }}
 
             [See release on PyPi](${{ steps.metadata.outputs.link }})
-
-  # Builds and publishes production docs.
-  #
-  # Only runs on tag pushes.
-  publish_docs:
-    name: Publish docs to GitHub Pages
-    needs:
-      - build_docs
-      - publish_to_pypi
-    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

.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