Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ Thumbs.db
.ai/
nitin_docs/

# Sphinx build output
# MkDocs build output
site/
docs/_build/


Expand Down
4 changes: 2 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ build:
UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" \
~/.local/bin/uv sync --frozen --group docs

sphinx:
configuration: docs/conf.py
mkdocs:
configuration: mkdocs.yml
Comment on lines +24 to +25
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Remove unsupported RTD formats for MkDocs builds

Switching this project from sphinx to mkdocs while leaving formats: [pdf, epub] enabled makes the Read the Docs config inconsistent with RTD’s MkDocs support: RTD’s config reference explicitly warns that additional formats (pdf, epub, htmlzip) are not supported for MkDocs projects. This can cause post-merge RTD builds to fail or remain in an error state even if local mkdocs build passes, blocking docs publication.

Useful? React with 👍 / 👎.


formats:
- pdf
Expand Down
6 changes: 3 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ Full reference, generated from docstrings, is at `docs/api/`.

| Artifact | Purpose |
|---|---|
| [`docs/llms.txt`](docs/llms.txt) | Flat index of every doc page with one-line summaries. Cheap to grep, good for in-context injection. |
| [`docs/api/`](docs/api/) | Sphinx `autoclass` reference for every public symbol. Source of truth for method signatures. |
| [`llms.txt`](https://docs.redisvl.com/projects/sql-redis/llms.txt) | Auto-generated flat index of every doc page with one-line summaries. Built by `mkdocs-llmstxt` at deploy time. Good for in-context injection. |
| [`docs/api/`](docs/api/) | mkdocstrings reference for every public symbol, generated from Google-style docstrings. Source of truth for method signatures. |
| [`docs/user_guide/how_to_guides/`](docs/user_guide/how_to_guides/) | Task-oriented recipes (vector search, GEO, dates, async, parameters). |
| [`docs/concepts/`](docs/concepts/) | Why-style explanation: architecture, parameter substitution, schema-aware translation. |
| [`docs/for-ais-only/`](docs/for-ais-only/) | Internal repo map for agents modifying the library. |
Expand All @@ -107,7 +107,7 @@ Full reference, generated from docstrings, is at `docs/api/`.
sql-redis sits in the [Redis AI Hub](https://redis.io/ai-hub/) under the
*Experimental* tier as "SQL for Redis". Public docs URL:
[`docs.redisvl.com/projects/sql-redis/`](https://docs.redisvl.com/projects/sql-redis/).
The hub's docs standards (Diataxis layout, autoclass-driven API reference,
The hub's docs standards (Diataxis layout, docstring-driven API reference,
AI-agent affordances) are documented at
[`HUB_DOCS_STANDARDS.md`](https://github.com/redis/docs/blob/main/HUB_DOCS_STANDARDS.md)
in the hub repo.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,11 @@ build: ## Build wheel and source distribution

docs-build: ## Build documentation
@echo "📚 Building documentation"
uv run --group docs make -C docs html
DISABLE_MKDOCS_2_WARNING=true uv run --group docs mkdocs build --strict

docs-serve: ## Serve documentation locally at http://localhost:8000
@echo "🌐 Serving documentation at http://localhost:8000"
@echo "📁 Make sure docs are built first with 'make docs-build'"
uv run python -m http.server --directory docs/_build/html
DISABLE_MKDOCS_2_WARNING=true uv run --group docs mkdocs serve --dev-addr 127.0.0.1:8000

clean: ## Clean up build artifacts and caches
@echo "🧹 Cleaning up directory"
Expand All @@ -69,6 +68,7 @@ clean: ## Clean up build artifacts and caches
find . -type d -name "build" -exec rm -rf {} + 2>/dev/null || true
find . -type d -name "*.egg-info" -exec rm -rf {} + 2>/dev/null || true
find . -type f -name "*.log" -exec rm -rf {} + 2>/dev/null || true
rm -rf site

help: ## Show this help message
@echo "Available commands:"
Expand Down
Loading
Loading