Add Sphinx-based docs (#254)

* Add placeholder for docs

* Add docs

* Add images

* Tidy up docs

* Let the AI improve wording

* Add brief contributor guide

* Improve dev guide

* Improve contributor guide

* Add pipeline for github docs

* Remove stuff from README.md

* Add pipeline for deploying docs

Author: gabotechs

.gitattributes

@@ -1 +1,2 @@
 *.parquet filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text

.github/workflows/docs.yml

@@ -0,0 +1,55 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          pip install -r docs/requirements.txt
+
+      - name: Build documentation
+        run: |
+          cd docs
+          make html
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: docs/build/html
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -0,0 +1,3 @@
+build/
+venv/
+temp/

docs/.gitignore

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= -W
+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)

docs/Makefile

@@ -0,0 +1,45 @@
+# DataFusion Distributed Documentation
+
+This directory contains the documentation for DataFusion Distributed, built using [Sphinx](https://www.sphinx-doc.org/).
+
+## Building the Documentation
+
+### Prerequisites
+
+Install the required dependencies:
+
+```bash
+pip install -r requirements.txt
+```
+
+### Build HTML Documentation
+
+```bash
+make html
+```
+
+The generated documentation will be available in `build/html/index.html`.
+
+### Clean Build Files
+
+```bash
+make clean
+```
+
+## Documentation Structure
+
+- `source/` - Documentation source files (reStructuredText and Markdown)
+  - `user-guide/` - User-facing documentation
+  - `architecture/` - Architecture documentation
+  - `contributor-guide/` - Contributor documentation
+  - `_static/` - Static files (images, CSS, etc.)
+  - `_templates/` - Custom templates
+
+## Contributing
+
+When adding new documentation:
+
+1. Create new `.md` or `.rst` files in the appropriate subdirectory
+2. Add references to new files in the relevant `index.rst` or `index.md`
+3. Build and preview your changes locally
+4. Ensure all links and references work correctly

docs/README.md

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+make clean
+make html

docs/build.sh

@@ -0,0 +1,7 @@
+sphinx==8.2.3
+sphinx-reredirects==1.0.0
+pydata-sphinx-theme==0.16.1
+myst-parser==4.0.1
+maturin==1.10.2
+jinja2==3.1.6
+setuptools==80.9.0