From 2dd795d76beb6fbcc90d5f60106446afad0bd807 Mon Sep 17 00:00:00 2001
From: h <h@kotikot.com>
Date: Mon, 19 Jan 2026 01:34:29 +0100
Subject: [PATCH] chore(docs): add readthedocs config, add docs link

---
 .readthedocs.yaml | 14 ++++++++++++++
 README.md         |  5 +++++
 pyproject.toml    |  1 +
 3 files changed, 20 insertions(+)
 create mode 100644 .readthedocs.yaml

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..6de34e1
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,14 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - path: .
+    - requirements: docs/requirements.txt
diff --git a/README.md b/README.md
index 2678708..725cc12 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,7 @@
 [![PyPI version](https://badge.fury.io/py/pyqt-liquidglass.svg)](https://pypi.org/project/pyqt-liquidglass/)
 [![Python Version](https://img.shields.io/badge/python-3.13+-blue.svg)](https://www.python.org/downloads/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)
+[![Documentation](https://readthedocs.org/projects/pyqt-liquidglass/badge/?version=latest)](https://pyqt-liquidglass.readthedocs.io)
 
 macOS Liquid Glass effects for PySide6 and PyQt6.
 
@@ -80,6 +81,10 @@ glass.apply_glass_to_window(window, options=options)
 
 Tested with PySide6. PyQt6 should work but is not explicitly tested.
 
+## Documentation
+
+Full documentation: [pyqt-liquidglass.readthedocs.io](https://pyqt-liquidglass.readthedocs.io)
+
 ## License
 
 MIT
diff --git a/pyproject.toml b/pyproject.toml
index 664c113..4b567e1 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -37,6 +37,7 @@ keywords = [
 
 [project.urls]
 Homepage = "https://git.kotikot.com/lib/pyqt-liquidglass"
+Documentation = "https://pyqt-liquidglass.readthedocs.io"
 Repository = "https://github.com/kotikotprojects/pyqt-liquidglass"
 
 [build-system]