From 32801cf7398b642cac023e4e9ecccc1d6880f47a Mon Sep 17 00:00:00 2001 From: Robert Shelton Date: Thu, 18 Jun 2026 15:43:36 -0400 Subject: [PATCH] fix(docs): point docs at GitHub Pages, the actual host sql-redis docs are published to GitHub Pages by docs.yml (redis-developer.github.io/sql-redis). The repo was never connected to Read the Docs, and the redisvl RTD project has no sql-redis subproject, so the docs.redisvl.com URLs 404. Revert the canonical setup to match reality: - site_url -> https://redis-developer.github.io/sql-redis/ - pyproject Documentation -> the GitHub Pages URL - remove .readthedocs.yaml, which implied an RTD build that does not exist This supersedes the site_url change in #34, which assumed RTD hosting. --- .readthedocs.yaml | 29 ----------------------------- mkdocs.yml | 2 +- pyproject.toml | 2 +- 3 files changed, 2 insertions(+), 31 deletions(-) delete mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index 97dd9b5..0000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,29 +0,0 @@ -# Read the Docs configuration file -# https://docs.readthedocs.io/en/stable/config-file/v2.html - -version: 2 - -build: - os: ubuntu-24.04 - tools: - python: "3.11" - - jobs: - pre_create_environment: - - | - curl -Ls https://astral.sh/uv/install.sh | bash - - create_environment: - - ~/.local/bin/uv venv "${READTHEDOCS_VIRTUALENV_PATH}" - - install: - - | - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" \ - ~/.local/bin/uv sync --frozen --group docs - -mkdocs: - configuration: mkdocs.yml - -formats: - - pdf - - epub diff --git a/mkdocs.yml b/mkdocs.yml index 271087b..baec9e7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: sql-redis site_description: SQL to Redis FT.SEARCH and FT.AGGREGATE translator. -site_url: !ENV [READTHEDOCS_CANONICAL_URL, "https://docs.redisvl.com/projects/sql-redis/en/stable/"] +site_url: https://redis-developer.github.io/sql-redis/ repo_url: https://github.com/redis-developer/sql-redis repo_name: redis-developer/sql-redis edit_uri: edit/main/docs/ diff --git a/pyproject.toml b/pyproject.toml index 1c97489..9567428 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,7 +29,7 @@ dependencies = [ [project.urls] Homepage = "https://github.com/redis-developer/sql-redis" Repository = "https://github.com/redis-developer/sql-redis" -Documentation = "https://docs.redisvl.com/projects/sql-redis/" +Documentation = "https://redis-developer.github.io/sql-redis/" [build-system] requires = ["hatchling"]