feat: add initial Read the Docs configuration and update README with hero image

This commit is contained in:
Christian Krakau-Louis
2025-04-04 00:11:17 +02:00
parent bd3d9ca775
commit 8e22ef0f61
4 changed files with 52 additions and 0 deletions
+22
View File
@@ -0,0 +1,22 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS, Python version, and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.13"
# Build documentation with Mkdocs
mkdocs:
configuration: mkdocs.yml
# Optionally, but recommended,
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: requirements.txt