docs: overhaul documentation structure and content#386
Merged
Conversation
Restructure docs with expanded reference pages (per-adapter, per-builder, per-extension), new usage guides (ETL, filtering, testing), recipes section (Dishka DI, service layer), VHS demo tape infrastructure, and streamlined installation page. Add gitignore for generated demo GIFs.
VHS parses unquoted parentheses and single quotes inside double-quoted Type commands as separate commands. Switch to backtick-quoted strings to avoid parsing errors.
…ements - Improved descriptions in README.md and PYPI_README.md, emphasizing SQL injection prevention and added features like built-in storage layer and framework integrations. - Refined example code for raw expressions, upsert, and multi-database configurations for better readability. - Enhanced service layer pattern documentation with async and sync examples, including pagination and error handling. - Updated various example scripts to streamline SQL execution and improve code clarity. - Adjusted Pygments styles to remove redundant comments on keywords.
…o class documentation
…hinx warnings Redesign light/dark Pygments palettes to use 7 distinct hue sectors instead of 3 blue variants, improving token differentiation in code blocks. Sync CodeMirror playground colors to match. Improve code block CSS container with subtle depth, gold accent border, and better spacing. Fix two sphinx build warnings: - Set explicit __signature__ on sql factory instance for autodoc - Use py:data directive for database_group CLI object
…nature__ crash The previous fix set __signature__ on the SQLFactory instance at module level, but mypyc-compiled classes reject arbitrary attribute assignment. Replace autofunction with py:data directive instead.
…g and rollback handling
…ection Add postgres extension auto-detection to ADBC adapter, matching asyncpg/psycopg/psqlpy feature parity. On first provide_session() call with a PostgreSQL backend, queries pg_extension for vector and pg_search extensions and upgrades the dialect accordingly. - Add enable_pgvector/enable_paradedb flags to AdbcDriverFeatures - Add detect_postgres_extensions() helper in core.py - Cache detection on config instance (_pgvector_available/_paradedb_available) - Update is_postgres_dialect() and type_converter for pgvector/paradedb dialects - Add integration tests for pgvector (9 tests) and paradedb (8 tests) - Add 12 unit tests for detection logic - Update docs with extension dialect section and driver features reference
- Add explicit ::vector cast on INSERT params (ADBC sends text, postgres rejects implicit text→vector coercion) - Ensure pgvector extension exists before config detection runs via _ensure_pgvector_extension session fixture - Use result[i]["col"] instead of result.data[i]["col"] for ADBC dict access (ADBC .data returns raw tuples, __getitem__ materializes dicts)
…b tests Replace result[i]["col"] and for-row-in-result patterns with the established result.get_data()[i]["col"] convention used throughout the ADBC test suite.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.gitignoreentry for generated demo GIFs