Integrate readthedocs.io

We publish the docs to readthedocs.io

.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: .

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)

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

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"