Skip to content

docs: overhaul docs#696

Merged
cofin merged 9 commits intomainfrom
chore/1.9.0-docs
Mar 24, 2026
Merged

docs: overhaul docs#696
cofin merged 9 commits intomainfrom
chore/1.9.0-docs

Conversation

@cofin
Copy link
Copy Markdown
Member

@cofin cofin commented Mar 24, 2026

Summary

  • Modularized Modeling and Repositories sections into nested directories.
  • Added new guides for SQLAlchemy Inheritance Patterns (STI, JTI, CTI).
  • Added new guide for SQLModel compatibility.
  • Updated documentation for v1.9.0b2 features: NullFilter, NotNullFilter, with_for_update, and recursive model_from_dict.
  • Integrated Sybil for automated testing of documentation code snippets.
  • Aligned documentation style with project standards (removed pipe union syntax and future annotations).

- Expanded Starlette integration documentation with setup instructions, session management, and commit modes.
- Updated inheritance modeling examples to include async session handling.
- Improved SQLModel usage documentation with async session creation and listing examples.
- Revised types documentation to clarify usage of various data types and added examples for new models.
- Enhanced advanced repository documentation with composite primary key support and filtering examples.
- Added basic repository usage examples for blog post and tag models.
- Updated filtering documentation with new filtering capabilities and pagination examples.
- Improved routing documentation to include managed PostgreSQL examples for Google Cloud SQL and AlloyDB.
- Refined services documentation with inline model definitions and enhanced service usage examples.
- Updated pyproject.toml to include documentation tests in test paths.
- Removed unused Sybil integration from test configuration.
@cofin cofin changed the title docs: modularize and update for v1.9.0b2 docs: overhaul docs & enable CI testing Mar 24, 2026
@cofin cofin changed the title docs: overhaul docs & enable CI testing docs: overhaul docs Mar 24, 2026
Comment thread docs/usage/frameworks/fastapi.rst
Copy link
Copy Markdown
Member

@JacobCoffee JacobCoffee left a comment

Choose a reason for hiding this comment

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

Sybil looks slick

@sonarqubecloud
Copy link
Copy Markdown

@cofin cofin enabled auto-merge (squash) March 24, 2026 22:50
@cofin cofin merged commit e58b615 into main Mar 24, 2026
21 checks passed
@cofin cofin deleted the chore/1.9.0-docs branch March 24, 2026 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants