sqliter-py/mkdocs.yml at main · seapagan/sqliter-py · 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
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
site_name: SQLiter

# default to using the material theme
theme:
  name: material
  palette:
    primary: light-blue
    accent: blue
  features:
    - navigation.footer
    - navigation.expand
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - content.code.copy

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/seapagan/simple-toml-settings
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/gnramsay_dev
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

copyright: © 2024-2026 Grant Ramsay (Seapagan)

repo_name: SQLiter
repo_url: https://github.com/seapagan/sqliter-py

hooks:
  - docs/hooks/google_style_notes.py

plugins:
  - search
  - privacy
  - minify:
      minify_html: true
      minify_css: true
      minify_js: true
      htmlmin_opts:
        remove_comments: true
        remove_empty_space: true

markdown_extensions:
  - mdx_truly_sane_lists
  - admonition
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.highlight:
      linenums: false
      auto_title: false
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra_css:
  - css/extra.css

nav:
  - Home:
      - Introduction: index.md
      - Installation: installation.md
      - Quick Start: quickstart.md
  - Guide:
      - Overview: guide/guide.md
      - Models: guide/models.md
      - Connect to a Database: guide/connecting.md
      - Properties: guide/properties.md
      - Table Operations: guide/tables.md
      - Data Operations: guide/data-operations.md
      - Transactions: guide/transactions.md
      - Filtering Results: guide/filtering.md
      - Ordering: guide/ordering.md
      - Aggregates and Grouping: guide/aggregates.md
      - Field Control: guide/fields.md
      - Foreign Keys:
          - Overview: guide/foreign-keys.md
          - Explicit Foreign Keys: guide/foreign-keys/explicit.md
          - ORM Foreign Keys: guide/foreign-keys/orm.md
      - Many-to-Many: guide/many-to-many.md
      - Caching: guide/caching.md
      - Exceptions: guide/exceptions.md
      - Debug Logging: guide/debug.md
  - API Reference:
      - Overview: api-reference/index.md
      - SqliterDB: api-reference/sqliterdb.md
      - BaseDBModel: api-reference/base-model.md
      - QueryBuilder: api-reference/query-builder.md
      - Foreign Keys: api-reference/foreign-keys.md
      - ORM Mode: api-reference/orm.md
      - Many-to-Many: api-reference/many-to-many.md
      - Exceptions: api-reference/exceptions.md
      - Helpers & Constants: api-reference/helpers.md
  - Interactive Demo:
      - Overview: tui-demo/index.md
      - Database Connection: tui-demo/connection.md
      - Models: tui-demo/models.md
      - CRUD Operations: tui-demo/crud.md
      - Filtering: tui-demo/filters.md
      - String Filters: tui-demo/string-filters.md
      - Field Selection: tui-demo/field-selection.md
      - Query Results: tui-demo/results.md
      - Ordering: tui-demo/ordering.md
      - Constraints: tui-demo/constraints.md
      - ORM Features: tui-demo/orm.md
      - Caching: tui-demo/caching.md
      - Auto Timestamps: tui-demo/timestamps.md
      - Transactions: tui-demo/transactions.md
      - Error Handling: tui-demo/errors.md
  - Changelog:
      - changelog/index.md
  - Contributing:
      - contributing/index.md
  - TODO List:
      - todo/index.md
  - License: license.md