-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
mkdocs.yml
151 lines (147 loc) 路 4.26 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
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
site_name: Edgy
site_description: 馃敟 The perfect ORM to work with complex databases 馃敟.
site_url: https://edgyorm.tarsild.io
theme:
name: "material"
custom_dir: docs/overrides
language: en
palette:
- scheme: "default"
primary: "pink"
accent: "red"
media: "(prefers-color-scheme: light)"
toggle:
icon: "material/lightbulb"
name: "Switch to dark mode"
- scheme: "slate"
media: "(prefers-color-scheme: dark)"
primary: "pink"
accent: "red"
toggle:
icon: "material/lightbulb-outline"
name: "Switch to light mode"
favicon: statics/images/favicon.ico
logo: statics/images/white.png
features:
- search.suggest
- search.highlight
- content.tabs.link
- content.code.copy
- content.code.annotate
- content.tooltips
- content.code.select
- navigation.indexes
- navigation.path
- navigation.tabs
repo_name: dymmond/edgy
repo_url: https://github.com/dymmond/edgy
edit_uri: ""
plugins:
- search
- meta-descriptions:
export_csv: false
quiet: false
enable_checks: false
min_length: 50
max_length: 160
trim: false
- markdownextradata:
data: data
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_typingdoc
show_root_heading: true
show_if_no_docstring: true
preload_modules: [databasez]
inherited_members: true
members_order: source
separate_signature: true
unwrap_annotated: true
filters: ["!^_"]
merge_init_into_class: true
docstring_section_style: spacy
signature_crossrefs: true
show_symbol_type_heading: true
show_symbol_type_toc: true
nav:
- Home: "index.md"
- Edgy: "edgy.md"
- Core:
- Models: "models.md"
- Declarative Models: "declarative-models.md"
- Reflection: "reflection.md"
- Managers: "managers.md"
- Fields: "fields.md"
- Queries:
- Queries: "queries/queries.md"
- Secrets: "queries/secrets.md"
- Related Name: "queries/related-name.md"
- ManyToMany: "queries/many-to-many.md"
- Prefetch Related: "queries/prefetch.md"
- Transactions: "transactions.md"
- Features:
- Signals: "signals.md"
- Relationships: "relationships.md"
- Reference ForeignKey: "reference-foreignkey.md"
- Marshalls: "marshalls.md"
- Connection: "connection.md"
- Tenancy:
- Edgy: "tenancy/edgy.md"
- Contrib: "tenancy/contrib.md"
- Registry: "registry.md"
- Shell Support: "shell.md"
- Inspect DB: "inspectdb.md"
- Migrations:
- Discovery: "migrations/discovery.md"
- Migrations: "migrations/migrations.md"
- Settings: "settings.md"
- Extras:
- Exceptions: "exceptions.md"
- Tips and Tricks: "tips-and-tricks.md"
- Extras: "extras.md"
- Test Client: "test-client.md"
- API Reference:
- "references/index.md"
- Model: "references/models.md"
- ReflectModel: "references/reflect-model.md"
- Manager: "references/manager.md"
- QuerySet: "references/queryset.md"
- Signals: "references/signals.md"
- Fields:
- Field: "references/fields.md"
- OneToOne: "references/one-to-one.md"
- ForeignKey: "references/foreignkey.md"
- ManyToMany: "references/many-to-many.md"
- Reference ForeignKey: "references/reference-foreign-key.md"
- Registry: "references/registry.md"
- Schema: "references/schemas.md"
- Database: "references/database.md"
- About:
- Edgy People: "edgy-people.md"
- Contributing: "contributing.md"
- Sponsorship: "sponsorship.md"
- Release Notes: "release-notes.md"
markdown_extensions:
- attr_list
- toc:
permalink: true
- mdx_include:
base_path: docs
- admonition
- extra
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format ""
- pymdownx.tabbed:
alternate_style: true
- md_in_html
extra:
alternate:
- link: /
name: English
lang: en