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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
site_name: flask-openapi3
site_url: https://luolingchun.github.io/flask-openapi3/
site_description: Generate REST API and OpenAPI documentation for your Flask project.
site_author: llc
repo_url: https://github.com/luolingchun/flask-openapi3
repo_name: 'GitHub'
markdown_extensions:
- admonition
- toc:
permalink: ⚓︎
- md_in_html
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.highlight:
linenums: true
theme:
name: material
logo: images/logo.svg
favicon: images/logo-blue.svg
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-sunny
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-night
features:
- navigation.tracking
- navigation.footer
- navigation.top
# - navigation.expand
- search.suggest
- search.highlight
- search.share
- content.code.copy
- content.action.edit
- content.action.view
- toc.follow
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
show_root_heading: true
show_root_full_path: false
# - glightbox
# - i18n:
# docs_structure: suffix
# fallback_to_default: true
# reconfigure_material: true
# reconfigure_search: true
# languages:
# - build: true
# default: true
# locale: en
# name: English
# - build: true
# default: false
# locale: zh
# name: 简体中文
# nav_translations:
# API Reference: API 参考
# Changelog: 更新日志
# Contributing: 贡献
# Example: 示例
# Home: 简介
# LICENSE: 许可
# Model Config: 模型配置
# Quickstart: 快速开始
# Request: 请求
# Response: 响应
# Route Operation: 路由操作
# Specification: 规范
# UI Templates: 自定义模板
# Configuration: 配置
# Usage: 教程
extra:
version:
provider: mike
extra_javascript:
- js/db.js
extra_css:
- css/img.css
nav:
- Home: index.md
- Quickstart: Quickstart.md
- Usage:
- Specification: Usage/Specification.md
- Request: Usage/Request.md
- Response: Usage/Response.md
- Route Operation: Usage/Route_Operation.md
- Model Config: Usage/Model_Config.md
- Configuration: Usage/Configuration.md
- UI Templates: Usage/UI_Templates.md
- JSON: Usage/JSON.md
- Example: Example.md
- API Reference:
- APIScaffold: Reference/Scaffold.md
- OpenAPI: Reference/OpenAPI.md
- APIBlueprint: Reference/APIBlueprint.md
- APIView: Reference/APIView.md
- Models: Reference/Models.md
- LICENSE: LICENSE.md
- Changelog: Changelog.md
- Contributing: Contributing.md
use_directory_urls: false
|
