FilesExpand file tree

main

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

229 lines (219 loc) · 6.11 KB

main

/

mkdocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

229 lines (219 loc) · 6.11 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

INHERIT: ./mkdocs.maybe-insiders.yml

site_name: SQLModel

site_description: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness.

site_url: https://sqlmodel.tiangolo.com/

theme:

name: material

custom_dir: docs/overrides

palette:

- media: "(prefers-color-scheme)"

toggle:

icon: material/lightbulb-auto

name: Switch to light mode

- media: '(prefers-color-scheme: light)'

scheme: default

primary: deep purple

accent: amber

toggle:

icon: material/lightbulb

name: Switch to dark mode

- media: '(prefers-color-scheme: dark)'

scheme: slate

primary: deep purple

accent: amber

toggle:

icon: material/lightbulb-outline

name: Switch to system preference

features:

- content.code.annotate

- content.code.copy

# - content.code.select

- content.footnote.tooltips

- content.tabs.link

- content.tooltips

- navigation.footer

- navigation.indexes

- navigation.instant

- navigation.instant.prefetch

# - navigation.instant.preview

- navigation.instant.progress

- navigation.path

- navigation.tabs

- navigation.tabs.sticky

- navigation.top

- navigation.tracking

- search.highlight

- search.share

- search.suggest

- toc.follow

icon:

repo: fontawesome/brands/github-alt

logo: img/icon-white.svg

favicon: img/favicon.png

language: en

repo_name: fastapi/sqlmodel

repo_url: https://github.com/fastapi/sqlmodel

plugins:

# Material for MkDocs

search:

social:

# Other plugins

macros:

include_yaml:

- sponsors: data/sponsors.yml

- members: data/members.yml

nav:

- SQLModel: index.md

- features.md

- Learn:

- learn/index.md

- databases.md

- db-to-code.md

- environment-variables.md

- virtual-environments.md

- install.md

- Tutorial - User Guide:

- tutorial/index.md

- tutorial/create-db-and-table-with-db-browser.md

- tutorial/create-db-and-table.md

- tutorial/insert.md

- tutorial/automatic-id-none-refresh.md

- tutorial/select.md

- tutorial/where.md

- tutorial/indexes.md

- tutorial/one.md

- tutorial/limit-and-offset.md

- tutorial/update.md

- tutorial/delete.md

- Connect Tables - JOIN:

- tutorial/connect/index.md

- tutorial/connect/create-connected-tables.md

- tutorial/connect/create-connected-rows.md

- tutorial/connect/read-connected-data.md

- tutorial/connect/update-data-connections.md

- tutorial/connect/remove-data-connections.md

- Relationship Attributes:

- tutorial/relationship-attributes/index.md

- tutorial/relationship-attributes/define-relationships-attributes.md

- tutorial/relationship-attributes/create-and-update-relationships.md

- tutorial/relationship-attributes/read-relationships.md

- tutorial/relationship-attributes/remove-relationships.md

- tutorial/relationship-attributes/back-populates.md

- tutorial/relationship-attributes/cascade-delete-relationships.md

- tutorial/relationship-attributes/type-annotation-strings.md

- Many to Many:

- tutorial/many-to-many/index.md

- tutorial/many-to-many/create-models-with-link.md

- tutorial/many-to-many/create-data.md

- tutorial/many-to-many/update-remove-relationships.md

- tutorial/many-to-many/link-with-extra-fields.md

- tutorial/code-structure.md

- FastAPI and Pydantic:

- tutorial/fastapi/index.md

- tutorial/fastapi/simple-hero-api.md

- tutorial/fastapi/response-model.md

- tutorial/fastapi/multiple-models.md

- tutorial/fastapi/read-one.md

- tutorial/fastapi/limit-and-offset.md

- tutorial/fastapi/update.md

- tutorial/fastapi/update-extra-data.md

- tutorial/fastapi/delete.md

- tutorial/fastapi/session-with-dependency.md

- tutorial/fastapi/teams.md

- tutorial/fastapi/relationships.md

- tutorial/fastapi/tests.md

- Advanced User Guide:

- advanced/index.md

- advanced/decimal.md

- advanced/uuid.md

- Resources:

- resources/index.md

- help.md

- contributing.md

- management-tasks.md

- About:

- about/index.md

- alternatives.md

- management.md

- release-notes.md

markdown_extensions:

# Python Markdown

abbr:

attr_list:

footnotes:

md_in_html:

tables:

toc:

permalink: true

# Python Markdown Extensions

pymdownx.betterem:

smart_enable: all

pymdownx.caret:

pymdownx.highlight:

line_spans: __span

pymdownx.inlinehilite:

pymdownx.keys:

pymdownx.mark:

pymdownx.superfences:

custom_fences:

- name: mermaid

class: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

pymdownx.tilde:

# pymdownx blocks

pymdownx.blocks.admonition:

types:

- note

- attention

- caution

- danger

- error

- tip

- hint

- warning

# Custom types

- info

pymdownx.blocks.details:

pymdownx.blocks.tab:

alternate_style: True

# Other extensions

mdx_include:

markdown_include_variants:

extra:

analytics:

provider: google

property: G-J8HVTT936W

feedback:

title: Was this page helpful?

ratings:

- icon: material/emoticon-happy-outline

name: This page was helpful

data: 1

note: >-

Thanks for your feedback!

- icon: material/emoticon-sad-outline

name: This page could be improved

data: 0

note: >-

Thanks for your feedback!

social:

- icon: fontawesome/brands/github-alt

link: https://github.com/fastapi/sqlmodel

- icon: fontawesome/brands/twitter

link: https://twitter.com/tiangolo

- icon: fontawesome/brands/linkedin

link: https://www.linkedin.com/in/tiangolo

- icon: fontawesome/brands/dev

link: https://dev.to/tiangolo

- icon: fontawesome/brands/medium

link: https://medium.com/@tiangolo

- icon: fontawesome/solid/globe

link: https://tiangolo.com

extra_css:

- css/termynal.css

- css/custom.css

extra_javascript:

- js/termynal.js

- js/custom.js

hooks:

- scripts/mkdocs_hooks.py