chore(docs): add readthedocs config, add docs link

This commit is contained in:
h
2026-01-19 01:34:29 +01:00
parent ac88a19c13
commit 2dd795d76b
3 changed files with 20 additions and 0 deletions

14
.readthedocs.yaml Normal file
View File

@@ -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

View File

@@ -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

View File

@@ -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]