From b92d871acf2bd2ad77e8b6d5f2f2ccb8a2eaffaa Mon Sep 17 00:00:00 2001
From: Alexander Hess <alexander@webartifex.biz>
Date: Tue, 10 Sep 2024 03:11:59 +0200
Subject: [PATCH] Integrate readthedocs.io

We publish the docs to readthedocs.io
---
 .readthedocs.yml      | 17 +++++++++++++++++
 README.md             |  1 +
 docs/requirements.txt |  3 +++
 pyproject.toml        |  1 +
 4 files changed, 22 insertions(+)
 create mode 100644 .readthedocs.yml
 create mode 100644 docs/requirements.txt

diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644
index 0000000..78c25f1
--- /dev/null
+++ b/.readthedocs.yml
@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+formats: all
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - path: .
diff --git a/README.md b/README.md
index 60da5e3..ad173c5 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ The goal of the `lalib` project is to create
     by reading and writing code.
 
 
+[![Documentation: Status](https://readthedocs.org/projects/lalib/badge/?version=latest)](https://lalib.readthedocs.io/en/latest/?badge=latest)
 [![Test suite: Status](https://github.com/webartifex/lalib/actions/workflows/tests.yml/badge.svg)](https://github.com/webartifex/lalib/actions/workflows/tests.yml)
 [![Test coverage: codecov](https://codecov.io/github/webartifex/lalib/graph/badge.svg?token=J4LWOMVP0R)](https://codecov.io/github/webartifex/lalib)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..7c766a7
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,3 @@
+# The following pinned dependencies must be updated manually
+sphinx==8.0.2
+sphinx-autodoc-typehints==2.3.0
diff --git a/pyproject.toml b/pyproject.toml
index a65fccf..cb4bb05 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -21,6 +21,7 @@ description = "A Python library to study linear algebra"
 license = "MIT"
 readme = "README.md"
 
+documentation = "https://lalib.readthedocs.io"
 homepage = "https://github.com/webartifex/lalib"
 repository = "https://github.com/webartifex/lalib"