-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
101 lines (95 loc) · 2.68 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
---
site_name: Repository ORM
site_author: Lyz
site_url: https://lyz-code.github.io/repository-orm
nav:
- Repository ORM: index.md
- Repositories:
- repositories.md
- FakeRepository: fake_repository.md
- TinyDBRepository: tinydb_repository.md
- PypikaRepository: pypika_repository.md
- File Repositories:
- file_repositories.md
- LocalFileRepository: local_file_repository.md
- Models: models.md
- Testing: testing.md
- API Reference:
- Repository Implementations: reference_adapters.md
- Models: reference_models.md
- Exceptions: reference_exceptions.md
- Contributing:
- contributing.md
- Create new repository: new_repo.md
- Architecture Decision Records:
- adr/adr.md
- '001: Entity id_ definition': adr/001-entity_id_definition.md
- '002: String id_ support': adr/002-support_string_ids.md
- '003: Make entity_models optional arguments': adr/003-make_entity_models_optional_arguments.md
- '004: Add complex queries': adr/004-add_complex_queries.md
- '005: Simplify search and all signature': adr/005-simplify_search_and_all_signature.md
- '006: Drop support for string IDs': adr/006-drop_again_string_ids.md
plugins:
- search
- mkdocstrings:
handlers:
python:
rendering:
show_root_heading: true
heading_level: 1
watch:
- src
- autolinks
- git-revision-date-localized:
type: timeago
fallback_to_build_date: true
- section-index
markdown_extensions:
- abbr
- def_list
- admonition
# We need the markdown-include to inject files into other files
- markdown_include.include:
base_path: docs
- meta
- toc:
permalink: true
baselevel: 2
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_generator: '!!python/name:pymdownx.emoji.to_svg'
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
theme:
name: material
custom_dir: docs/theme
# logo: 'images/logo.bmp'
features:
- navigation.instant
- navigation.top
- content.code.annotate
palette:
primary: blue grey
accent: light blue
extra_css:
- stylesheets/extra.css
- stylesheets/links.css
repo_name: lyz-code/repository-orm
repo_url: https://github.com/lyz-code/repository-orm