FilesExpand file tree

master

/

mkdocs.yml

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

113 lines (112 loc) · 2.98 KB

master

/

mkdocs.yml

Copy path

Top

File metadata and controls

• Code
• Blame

113 lines (112 loc) · 2.98 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

site_name: ormar

site_url: 'https://ormar-orm.github.io/ormar/'

site_description: A simple async ORM with fastapi in mind and pydantic validation.

nav:

- Overview: index.md

- Installation: install.md

- Models:

- Definition: models/index.md

- Inheritance: models/inheritance.md

- Methods: models/methods.md

- Migrations: models/migrations.md

- Internals: models/internals.md

- Fields:

- Common parameters: fields/common-parameters.md

- Fields types: fields/field-types.md

- Pydantic only fields: fields/pydantic-fields.md

- Fields encryption: fields/encryption.md

- Relations:

- Relation types: relations/index.md

- relations/foreign-key.md

- relations/many-to-many.md

- relations/postponed-annotations.md

- relations/queryset-proxy.md

- Queries:

- queries/index.md

- queries/create.md

- queries/read.md

- queries/update.md

- queries/delete.md

- queries/joins-and-subqueries.md

- queries/filter-and-sort.md

- queries/select-columns.md

- queries/pagination-and-rows-number.md

- queries/aggregations.md

- Return raw data: queries/raw-data.md

- Signals: signals.md

- Transactions: transactions.md

- Use with Fastapi:

- Quick Start: fastapi/index.md

- Using ormar in responses: fastapi/response.md

- Using ormar in requests: fastapi/requests.md

- Use with mypy: mypy.md

- Migration to v 0.20: migration.md

- PyCharm plugin: plugin.md

- Contributing: contributing.md

- Release Notes: releases.md

- Api (BETA): api/

repo_name: ormar-orm/ormar

repo_url: https://github.com/ormar-orm/ormar

theme:

name: material

highlightjs: true

hljs_languages:

- python

palette:

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

scheme: default

primary: indigo

accent: indigo

toggle:

icon: material/lightbulb

name: Switch to light mode

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

scheme: slate

primary: indigo

accent: indigo

toggle:

icon: material/lightbulb-outline

name: Switch to dark mode

analytics:

gtag: G-ZJWZYM5DNM

markdown_extensions:

- admonition

- pymdownx.superfences

- pymdownx.snippets:

base_path: docs

- pymdownx.inlinehilite

- pymdownx.highlight:

linenums: true

auto_title: true

plugins:

- mike:

alias_type: symlink

canonical_version: latest

version_selector: true

- search

- gen-files:

scripts:

- docs/gen_ref_pages.py

- literate-nav:

nav_file: SUMMARY.md

- section-index

- mkdocstrings:

watch:

- ormar

handlers:

python:

selection:

docstring_style: sphinx

rendering:

show_submodules: no

extra:

analytics:

provider: google

property: UA-72514911-3

version:

provider: mike

extra_javascript:

- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js

- javascripts/config.js

extra_css:

- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/default.min.css