This repository has been archived by the owner on Jan 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
98 lines (98 loc) · 3.29 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
site_name: Turbulette
site_description: Turbulette - A batteries-included framework to build high performance, fully async GraphQL APIs
repo_url: https://github.com/turbulette/turbulette
repo_name: turbulette/turbulette
site_url: https://turbulette.github.io/turbulette/
theme:
name: material
palette:
scheme: slate
primary: blue
features:
- search.highlight
icon:
repo: fontawesome/brands/github
plugins:
- search:
lang: en
- git-revision-date
- mkdocstrings:
handlers:
python:
setup_commands:
# Disable lazy init to enable pytkdocs to collect objects
- from os import environ
- environ.setdefault("TURBULETTE_NO_LAZY_INIT", "True")
- from turbulette import turbulette_starlette
- turbulette_starlette("tests.settings_no_env")
selection:
new_path_syntax: yes
filters:
- "!^_" # exlude all members starting with _
- "^__init__$" # but always include __init__ modules and methods
watch:
- turbulette
markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.tabbed
- pymdownx.superfences
- admonition
- abbr
- attr_list
nav:
- Turbulette: index.md
- User Guide:
- Introduction: user_guide/index.md
- Project and applications: user_guide/project_apps.md
- Settings: user_guide/settings.md
- Database: user_guide/database.md
- GraphQL schema and resolvers: user_guide/graphql.md
- Data validation: user_guide/validation.md
- Error handling: user_guide/error_handling.md
- Authentication: user_guide/auth.md
- Authorization: user_guide/policy.md
- Reference:
- Applications:
- auth:
- GraphQL schema: reference/apps/auth/graphql.md
- Models: reference/apps/auth/models.md
- Pydantic models: reference/apps/auth/pyd_models.md
- Decorators: reference/apps/auth/decorators.md
- Core: reference/apps/auth/core.md
- Policy: reference/apps/auth/policy.md
- Utils: reference/apps/auth/utils.md
- Settings: reference/apps/auth/settings.md
- App management: reference/apps/app_management.md
- Custom scalars: reference/custom_scalars.md
- Database: reference/database/database.md
- Validation:
- Pydantic: reference/validation/pyd_model.md
- Decorators: reference/validation/decorators.md
- Error codes: reference/error_codes.md
- Routes handlers: reference/route_handlers.md
- Middlewares:
- CSRF: reference/middlewares/csrf.md
- Test: reference/test.md
- Turb CLI: reference/management/cli.md
- ASGI application: reference/asgi.md
- FAQ: faq.md
- Release Notes: changelogs.md
extra_css:
- css/custom.css
- css/termynal.css
extra_javascript:
- js/termynal.js
- js/custom.js
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/turbulette/turbulette
- icon: fontawesome/brands/gitter
link: https://gitter.im/turbulette/turbulette
google_analytics:
- UA-183721846-1
- auto