mirror of
https://github.com/kennethreitz/responder.git
synced 2026-07-21 18:39:29 +00:00
kennethreitz
df0d20d6cd
Modernize the documentation for the v4.1.0 + v5.0.0 releases and take it up a notch across the board. Content: - Document v5 typed I/O (Query/Header/Cookie/Path markers, Pydantic body injection, return-annotation response_model), composable dependency injection, secure-by-default sessions, the deferred middleware stack, and type-hint-driven OpenAPI. - Fix now-broken examples: req.method is uppercase; response_model=list (broke /schema.yml and /docs); SECRET_KEY -> RESPONDER_SECRET_KEY; the built-in middleware-order list; the "no return values" Flask claim; the abort()/ before_request/exception_handler Quick Reference mappings. - Add a Granian production-server section to the deployment guide alongside uvicorn (Rust, single dependency, HTTP/2, WebSockets). Navigation & build: - Render the v5 migration guide as a first-class docs page and fix the changelog link to resolve on GitHub and in Sphinx. - Build out the alabaster sidebar: full cross-page navigation with captioned groups (User Guide / Tutorials / Reference / Project) and prev/next links; move guide-config into the User Guide. - Fix the HTTPMethod docstring RST so it renders in the API reference. Sphinx build is clean (0 warnings). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Symbolic link
18 B
Symbolic link
18 B
../migration-v5.md