forked from BeanieODM/beanie
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pydoc-markdown.yml
126 lines (118 loc) · 3.48 KB
/
pydoc-markdown.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
loaders:
- type: python
processors:
- type: filter
- type: smart
- type: crossref
hooks:
pre-render:
- mkdir -p docs/build/content
- cp -r docs/assets docs/build/content
- cp docs/CNAME docs/build/content
renderer:
type: mkdocs
output_directory: docs/build
mkdocs_config:
site_name: Beanie Documentation
site_url: https://roman-right.github.io/beanie/
theme:
name: material
palette:
- scheme: default
primary: white
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
logo: assets/logo.svg
favicon: assets/favicon.png
extra_css:
- assets/color_scheme.css
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
repo_url: https://github.com/roman-right/beanie
markdown:
use_fixed_header_levels: true
header_level_by_type:
Module: 1
Class: 2
Method: 3
Function: 3
Data: 3
descriptive_class_title: false
descriptive_module_title: false
add_method_class_prefix: true
add_member_class_prefix: true
docstrings_as_blockquote: true
pages:
- title: Overview
name: index
source: docs/index.md
- title: Getting started
source: docs/getting-started.md
- title: Tutorial
children:
- title: Defining a document
source: docs/tutorial/defining-a-document.md
- title: Initialization
source: docs/tutorial/init.md
- title: Inserting into the database
source: docs/tutorial/insert.md
- title: Finding documents
source: docs/tutorial/find.md
- title: Updating & Deleting
source: docs/tutorial/update.md
- title: Multi-model pattern
source: docs/tutorial/multi-model.md
- title: Indexes & collection names
source: docs/tutorial/collection_setup.md
- title: Aggregation
source: docs/tutorial/aggregate.md
- title: Relations
source: docs/tutorial/relations.md
- title: Views
source: docs/tutorial/views.md
- title: Event-based actions
source: docs/tutorial/actions.md
- title: Cache
source: docs/tutorial/cache.md
- title: Revision
source: docs/tutorial/revision.md
- title: State Management
source: docs/tutorial/state_management.md
- title: On save validation
source: docs/tutorial/on_save_validation.md
- title: Migrations
source: docs/tutorial/migrations.md
- title: API Documentation
children:
- title: Document
contents:
- beanie.odm.documents.*
- title: Query
contents:
- beanie.odm.queries.*
- title: Interfaces
contents:
- beanie.odm.interfaces.*
- title: Operators
children:
- title: Find
contents:
- beanie.odm.operators.find.*
- title: Update
contents:
- beanie.odm.operators.update.*
- title: Fields
contents:
- beanie.odm.fields.*
- title: Development
source: docs/development.md
- title: Code of conduct
source: docs/code-of-conduct.md
- title: Changelog
source: docs/changelog.md