b68a142a35
Replace `mkautodoc` by `mkdocstrings` ( #2776 )
2024-11-30 12:41:25 +01:00
c2e3a39b09
Match httpx documentation style ( #2742 )
2024-10-31 08:05:06 +01:00
616e682114
Remove short logo from documentation ( #2682 )
2024-09-01 20:48:01 +02:00
1eb4036110
Change documentation layout ( #2680 )
2024-09-01 17:06:20 +02:00
d3e65c1653
Deleting docs/js folder and extra_javascript in mkdocs.yaml ( #2311 )
2023-11-02 05:45:38 -06:00
cb6d284877
Add copy button on documentation ( #2257 )
2023-08-27 12:07:33 +00:00
7866bff1d9
Replace reference from Events to Lifespan on the mkdocs.yml ( #2072 )
2023-03-10 00:20:06 +01:00
5c3241a008
Add edit button on documentation pages
...
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2022-10-07 17:25:42 +02:00
5006a304fa
Improve wording and structure of pure ASGI middleware docs ( #1723 )
...
* Improve wording and structure of pure ASGI middleware docs
* Address feedback
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2022-08-09 12:08:52 +02:00
1225ae8404
Add contributing docs ( #1686 )
...
* Add contributing docs
* Add screenshots
* Update docs/contributing.md
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2022-06-18 18:34:13 +02:00
7a1108058b
Add dark theme for the documentation ( #1230 )
...
* mkdocs: expanded theme configuration to add alternative dark theme.
The default theme will be determined by the users system theme by the
`prefers-color-scheme` media query.
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
2021-09-18 13:08:29 +02:00
b65ba8b8ca
Add FastAPI sponsorship ( #1271 )
2021-08-19 15:17:41 +01:00
66266369bb
mkdocs: Set site_url ( #1215 )
2021-06-25 08:46:38 +01:00
23e15789bf
Fix docs syntax highlighting ( #1136 )
...
* mkdocs: Use python-markdown-extensions syntax highlighter
* mkdocs: Use 2-space indent consistently in config file
2021-02-07 19:06:30 +00:00
32745944b0
Deprecate built-in GraphQL support ( #1135 )
...
* Deprecate GraphQLApp
* Add deprecation warning to pytest ignore list
* Tweak deprecation warnings
2021-02-05 19:13:39 +00:00
8c72756e44
Add chat to docs ( #834 )
2020-02-19 10:37:43 +00:00
7f8cd04173
Version 0.13 ( #704 )
...
* Version 0.13
* Fix misnamed requirement
* Updating routing docs
* Update routing docs
* Update docs
* Simpler Middleware signature
* Update middleware docs
* Update exception docs
* Allow 'None' in middleware lists, for easy disabling of middleware.
* Update README
2019-11-13 12:25:18 +00:00
a46747377b
Add support for server push
...
This adds support for HTTP/2 and HTTP/3 server push by adding a
Request.send_push_promise method, which signals to push-enabled
servers that a push should be sent.
2019-09-02 14:01:30 +02:00
4d8435f1f7
Minor tweaks to third party package docs
2018-12-19 10:16:03 +00:00
25ad2dcd1d
Add Third Parties section to docs
2018-12-19 00:31:01 +04:00
ce9556acce
Authentication ( #256 )
...
* Authentication
* Fleshing out authentication support
* Version 0.9.6
2018-12-07 13:05:31 +00:00
08af34763d
Version 0.9.4 ( #251 )
2018-12-05 16:38:45 +00:00
e4ef8bdfaf
Database, not Databases
2018-12-04 16:25:27 +00:00
0b7819b4b2
Add DatabaseMiddleware ( #243 )
...
* Add `DatabaseMiddleware`
2018-12-04 16:05:16 +00:00
9f3dcb7d2b
Rejig ExceptionMiddleware and ServerErrorMiddleware ( #193 )
...
* Rejig ExceptionMiddleware and ServerErrorMiddleware
* Tweak DebugMiddleware implementation
* Support custom 500 handlers
* Exception handling updates
2018-11-08 11:59:15 +00:00
efecf56735
Add support for name to mount points. ( #184 )
...
* Support name on app.mount(...)
* Add templating docs
* Remove erronous commit
* Linting
2018-11-06 16:57:57 +00:00
81c4306a3a
Add OpenAPIResponse, API Schema docs, etc... ( #171 )
2018-11-01 12:52:03 +00:00
b52fd11f32
Add release notes
2018-10-29 09:33:33 +00:00
315a21be85
GraphQL support ( #126 )
...
* GraphQL support
* GraphQL support
* Run GraphQL queries inside a threadpool
* Support AsyncioExecutor
* GraphQL error formatting
* Docs for GraphQL support
2018-10-18 14:45:18 +01:00
139753f857
Add support for `app.on_event("startup")` and `app.on_event("cleanup")`. ( #98 )
...
* Push black linting into ./scripts/test Fix some annotations etc.
* Skip black on 3.7
* Fix script
* Blergh. Shell equality tests are weird
* Attempt to fix equality check
* Document 'allow_origin_regex'
* Support app.on_event('startup') and app.on_event('cleanup')
* Nicer decorator handling for on_event
* Add documentation for app.on_event()
2018-10-09 15:47:51 +01:00
19670ae2cd
Middleware ( #82 )
...
* Tweaks to URL datastructure
* Linting
* Add Middleware
2018-10-05 12:04:11 +01:00
ee32830003
Minor tweaks to background task docs
2018-10-02 11:47:49 +01:00
a7722cd245
Minor changes to docs layout
2018-09-05 13:45:39 +01:00
78d1829758
Version 0.3 ( #57 )
...
* Renamings
* Version 0.3.0
* Black formatting
* Update docs for 0.3
2018-09-05 11:39:38 +01:00
f4fe0ec312
Name changes ( #55 )
...
* Rename View -> HTTPEndpoint
* Rename views doc file -> endpoints
* Rename request/response files -> requests/responses, update imports, update docs
* Rename WebSocketSession -> WebSocket, rename session -> websocket in docs
* Full module imports in tests and source, removing imports from __init__ file
* Fix name in testclient doc
2018-09-05 10:29:04 +01:00
67d95fcfa7
Exception handling ( #54 )
...
* Exception handling
* Black formatting
* Add exception handling to App
* Handle cases where exception raised but response already started
* Order exception handler lookup by class inheritance
* Handle 404/405 as responses without App, or exceptions with it.
* Only use TestClient(app, raise_exceptions=False) explicitly inside test cases
* Documentation for ExceptionMiddleware
* Drop error_handler/exception_handler distinction.
* Finesse and document TestClient(app, raise_server_exceptions=False)
* Refactoring to make debug responses easier to obtain from elsewhere in code
* Use named status_code argument in example
* Clean up raise_server_errors usage in tests
* Consistent title-casing in HTTP reason phrases
* Black formatting
* Add WebSocketClose close. Omit message-body on 204, 304 exception cases.
* Black formatting
* Add 'debug' flag to App and ExceptionMiddleware
* Support app.debug
* Document debug mode
* Documenting debug
2018-09-04 11:52:29 +01:00
0693a8f6c9
Class based views ( #52 )
...
* Renaming asgi_application, implementing CBV pattern, add_route method on router
* Refactor view to allow both sync/async methods
* Type hints for CBV
* Implement asgi decorator method directly in view class, remove classmethod
* Refactor CBV, remove router add_route method in favor of App.add_route method, tests, documentation
* Include tests
* Add support for class-based views
2018-08-30 13:53:37 +01:00
352ccda556
Update docs
2018-08-29 11:17:09 +01:00
25990db22e
Add mkdocs
2018-08-28 16:25:32 +01:00
1f6fabc5e1
Add Applications docs to mkdocs
2018-08-28 08:11:53 -06:00
bb6a8fb7c9
Initial conversion of README.md to mkdocs
2018-08-28 07:58:03 -06:00
Marcelo Trylesinski