Merge pull request #40 from LLMSQL/page

Front_page

Author: DzmitryPihulski

.github/workflows/docs.yml

@@ -1,31 +1,90 @@
-name: Deploy Sphinx docs to GitHub Pages
+name: Build & Deploy Sphinx Docs
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      - page
+      - main
+  pull_request:
+    branches:
+      - main
 
 permissions:
   contents: read
   pages: write
   id-token: write
 
 jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          pip install -r docs/requirements.txt
+
+      - name: Build Sphinx docs
+        run: |
+          cd docs
+          python -m sphinx -b html . _build/html
+
+      - name: Upload artifact (HTML for preview)
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-html
+          path: docs/_build/html
+
+  preview:
+    if: github.ref == 'refs/heads/page'
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download built docs
+        uses: actions/download-artifact@v4
+        with:
+          name: docs-html
+          path: ./docs/_build/html
+
+      - name: Configure GitHub Pages preview
+        uses: actions/configure-pages@v4
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/_build/html
+
+      - name: Deploy preview
+        id: deployment
+        uses: actions/deploy-pages@v4
+
   deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - name: Download built docs
+        uses: actions/download-artifact@v4
+        with:
+          name: docs-html
+          path: ./docs/_build/html
 
-    - name: Setup Pages
-      uses: actions/configure-pages@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
 
-    - name: Upload artifact
-      uses: actions/upload-pages-artifact@v3
-      with:
-        path: ./docs/_build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/_build/html
 
-    - name: Deploy to GitHub Pages
-      id: deployment
-      uses: actions/deploy-pages@v4
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/_build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6ee7cd5529e806f473de3323ad247c53
+config: a32d920eac3b9747d56b69f1dc98ea4c
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/.buildinfo.bak

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: de581c93e813643e7cc922a04766d3b7
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/.doctrees/environment.pickle

@@ -1,36 +1 @@
-.. LLMSQL documentation master file, created by
-   sphinx-quickstart on Wed Sep 24 11:41:44 2025.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to LLMSQL project
-==========================
-
-.. image:: https://img.shields.io/pypi/v/llmsql
-   :target: https://pypi.org/project/llmsql/
-
-LLMSQL is a Python package for SQL reasoning with LLMs and vLLM inference.
-
-🚀 Features
------------
-- Easy vLLM inference integration
-- Evaluator utilities
-- HuggingFace + TRL support
-
-📦 Installation
----------------
-.. code-block:: bash
-
-   pip3 install llmsql
-
-🔗 Resources
-------------
-- `Source code on GitHub <https://github.com/LLMSQL/llmsql-benchmark>`_
-- `PyPI project <https://pypi.org/project/llmsql/>`_
-- `Dataset on Hugging Face <https://huggingface.co/llmsql-bench>`_
-- `Example Usages <https://github.com/LLMSQL/llmsql-benchmark/tree/main/examples>`_
-
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+.. This file exists only because Sphinx requires index.rst