mirror of https://github.com/encode/starlette.git
87 lines
2.3 KiB
YAML
87 lines
2.3 KiB
YAML
site_name: Starlette
|
|
site_description: The little ASGI library that shines.
|
|
site_url: https://www.starlette.io
|
|
|
|
theme:
|
|
name: "material"
|
|
custom_dir: docs/overrides
|
|
palette:
|
|
- scheme: "default"
|
|
media: "(prefers-color-scheme: light)"
|
|
toggle:
|
|
icon: "material/lightbulb"
|
|
name: "Switch to dark mode"
|
|
- scheme: "slate"
|
|
media: "(prefers-color-scheme: dark)"
|
|
primary: "blue"
|
|
toggle:
|
|
icon: "material/lightbulb-outline"
|
|
name: "Switch to light mode"
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
features:
|
|
- content.code.copy
|
|
- toc.follow
|
|
|
|
repo_name: encode/starlette
|
|
repo_url: https://github.com/encode/starlette
|
|
edit_uri: edit/master/docs/
|
|
|
|
nav:
|
|
- Introduction: "index.md"
|
|
- Features:
|
|
- Applications: "applications.md"
|
|
- Requests: "requests.md"
|
|
- Responses: "responses.md"
|
|
- WebSockets: "websockets.md"
|
|
- Routing: "routing.md"
|
|
- Endpoints: "endpoints.md"
|
|
- Middleware: "middleware.md"
|
|
- Static Files: "staticfiles.md"
|
|
- Templates: "templates.md"
|
|
- Database: "database.md"
|
|
- GraphQL: "graphql.md"
|
|
- Authentication: "authentication.md"
|
|
- API Schemas: "schemas.md"
|
|
- Lifespan: "lifespan.md"
|
|
- Background Tasks: "background.md"
|
|
- Server Push: "server-push.md"
|
|
- Exceptions: "exceptions.md"
|
|
- Configuration: "config.md"
|
|
- Test Client: "testclient.md"
|
|
- Release Notes: "release-notes.md"
|
|
- Community:
|
|
- Third Party Packages: "third-party-packages.md"
|
|
- Contributing: "contributing.md"
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.highlight
|
|
- pymdownx.superfences
|
|
- pymdownx.details
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
|
|
watch:
|
|
- starlette
|
|
|
|
plugins:
|
|
- search
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
options:
|
|
docstring_section_style: list
|
|
show_root_toc_entry: false
|
|
members_order: source
|
|
separate_signature: true
|
|
filters: ["!^_"]
|
|
docstring_options:
|
|
ignore_init_summary: true
|
|
merge_init_into_class: true
|
|
parameter_headings: true
|
|
show_signature_annotations: true
|
|
signature_crossrefs: true
|
|
import:
|
|
- url: https://docs.python.org/3/objects.inv
|