docs: Add GitHub Pages documentation site (MkDocs Material)#9
Merged
Conversation
- mkdocs.yml with Material theme (dark/light, search, code copy, tabs) - 14 documentation pages covering all features: - Landing page with feature cards and 30-second example - Installation guide with optional extras - Sync and async quickstarts (SQLAlchemy) - ORM adapters (SQLAlchemy/Tortoise/Peewee configuration) - Declarative eager loading (RelatedConfig) - Overriding handlers (custom LIST/POST) - OAuth2 authentication - Pagination, filtering & ordering - Custom routes and permissions - Full API reference (classes, methods, constants) - Comparison with alternatives - Changelog - GitHub Actions workflow for automatic deploy to GitHub Pages - docs extra in pyproject.toml - Documentation URL in project.urls
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
added 4 commits
July 25, 2026 16:31
…mparison claim - Workflow trigger: branches: [main] -> [master] - edit_uri: edit/main -> edit/master - authentication.md: clarify that OAuth2PasswordBearer only requires the header, not full JWT validation - comparison.md: soften 'No other library offers...' to 'A key differentiator...' - README: add docs badge and link
…pends, lifespan, workflow Blockers: - Replace PEP 604 union syntax (int | None) with Optional[int]/Union[int, str] in all doc examples (Python 3.9 compat, requires-python>=3.9) - Fix broken blob/main links to blob/master (LICENSE, CI badge, RELEASE_NOTES, changelog links) — default branch is master - Fix token parameter in override examples: Optional[str] = None → Depends(...) to prevent appearing as query param in OpenAPI - Add missing 'from sqlalchemy import select' in pagination-filtering.md Important: - Remove extra.version.provider: mike (not installed in workflow, causes 404) - Add pull_request trigger to docs workflow for pre-merge validation - Use pip install -e .[docs] instead of hardcoded package list - Guard deploy job with if: github.event_name == 'push' - Replace deprecated @app.on_event with asynccontextmanager lifespan - Add warning about non-functional search param in api-reference.md Minor: - Fix changelog version order (v1.2.1 after v1.2.0) - Correct fastapi-crudrouter ORM support description - Replace deprecated datetime.utcnow() with datetime.now(timezone.utc) - Add comment for undefined get_current_user in custom-routes.md - Document register_adapter, reset_default_adapter, serializer_utils, and _noop_dependency/butle alias in api-reference.md
- Fix Python 3.9 incompatibility: replace int | None with Optional[int] in docs/quickstart-sync.md and 3 README code blocks - Add public initialize() and close() methods to TortoiseAdapter; rewrite Tortoise lifecycle examples in docs/orm-adapters.md and README.md to use them instead of manual Tortoise.init() (fixes double-init bug) - Replace deprecated @app.on_event with lifespan in README async quickstart - Fix driver matrix: asyncpg is included in [tortoise] extra, not built-in; aiomysql must be installed separately - Clarify that SQLAlchemy is a core dependency in getting-started.md - Add v1.2.1 and v1.2.2 sections to changelog.md - Fix language tags: shell commands use bash, HTTP examples use text - Add security warning for OAuth2 demo token endpoint - Fix passlib note: not required for the token endpoint example
Mock-based tests that work with or without tortoise-orm installed, so they run in CI where only [test] extras are available. Fixes codecov/patch failure on PR #9.
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.
What
Adds a complete documentation site for GitHub Pages using MkDocs Material.
Pages (13 total)
Features
CI/CD
GitHub Actions workflow auto-deploys to GitHub Pages on every push to
mainthat touchesdocs/,mkdocs.yml, or the workflow itself.pyproject.toml changes
[docs]optional dependency group (mkdocs, mkdocs-material, pymdown-extensions)DocumentationURL to[project.urls]After merge
masterThe docs will be live at: https://svalench.github.io/fastapi_viewsets/