rick_db/mkdocs.yml at master · oddbit-project/rick_db · GitHub

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
site_name: RickDb
site_description: Simple SQL database layer
strict: true
site_url: https://github.com/oddbit-project/rick_db
repo_name: oddbit-project/rick_db
repo_url: https://github.com/oddbit-project/rick_db

theme:
  name: material
  palette:
  - scheme: slate
    primary: deep purple
    accent: amber
    toggle:
      icon: material/lightbulb
      name: Switch to light mode
  - scheme: default
    primary: deep purple
    accent: amber
    toggle:
      icon: material/lightbulb-outline
      name: Switch to dark mode
  features:
  - search.suggest
  - search.highlight
  - content.tabs.link
  - content.code.copy
  - navigation.top
  icon:
    repo: fontawesome/brands/github-alt
  language: en

nav:
- Overview: index.md
- install.md
- connection.md
- object_mapper.md
- Query Builder: building_queries.md
- JSON Operations: json_operations.md
- repository.md
- grid.md
- migrations.md
- Examples: examples.md
- Class List:
  - Record: 'classes/record.md'
  - Connection: 'classes/connection.md'
  - Cursor: 'classes/cursor.md'
  - Profiler: 'classes/profiler.md'
  - Repository: 'classes/repository.md'
  - Errors: 'classes/errors.md'
  - SqlDialect: 'classes/sqldialect.md'
  - MySqlSqlDialect: 'classes/mysql_dialect.md'
  - Select: 'classes/select.md'
  - Insert: 'classes/insert.md'
  - Update: 'classes/update.md'
  - Delete: 'classes/delete.md'
  - Literal: 'classes/literal.md'
  - Fn: 'classes/fn.md'
  - JsonField: 'classes/jsonfield.md'
  - PgJsonField: 'classes/pgjsonfield.md'
  - CTEs (With): 'classes/with.md'
  - DbGrid: 'classes/dbgrid.md'
  - QueryCache: 'classes/querycache.md'
  - Pool: 'classes/poolinterface.md'
  - FieldRecord: 'classes/fieldrecord.md'
  - UserRecord: 'classes/userrecord.md'
  - Manager:
    - Manager: 'classes/managerinterface.md'
    - PgManager & PgInfo: 'classes/pgmanager.md'
    - Sqlite3Manager: 'classes/sqlite3manager.md'
    - ClickHouseManager: 'classes/clickhousemanager.md'
  - ClickHouse:
    - ClickHouse SQL & Repository: 'classes/clickhouse_sql.md'

markdown_extensions:
- toc:
    permalink: true
- admonition
- extra
- pymdownx.highlight:
    anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format ''
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.details
- mdx_include:
    base_path: docs

extra:
  social:
  - icon: fontawesome/brands/github-alt
    link: https://github.com/oddbit-project/rick_db