supadantic/mkdocs.yml at master · makridenko/supadantic · 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
site_name: Supadantic
repo_url: https://github.com/makridenko/supadantic
site_url: https://makridenko.github.com/supadantic
site_description: Supadantic is a small Python library that allows you to manage Supabase tables through Pydantic models. It is very convenient to use in projects based on FastAPI, Flask, and so on.
copyright: Maintained by <a href="https://github.com/makridenko/">Alexey Makridenko</a>

nav:
- Home:
  - Overview: index.md
  - FastAPI Example: fast_api_usage.md
  - Filters Usage: filters_usage.md
- API Documentation:
  - Clients:
    - BaseClient: clients/base.md
    - CacheClient: clients/cache.md
    - SupabaseClient: clients/supabase.md
  - Models:
    - BaseSBModel:
      - ModelMetaclass: models/model_metaclass.md
      - BaseSBModel: models/base_sb_model.md
  - QSet: q_set.md
  - QueryBuilder: query_builder.md

plugins:
- search
- mkdocstrings:
    handlers:
      python:
        options:
          docstring_style: google
          show_doctring_examples: true
          merge_init_into_class: true
          show_source: true
          docstring_options:
            ignore_init_summary: true
          separate_signature: true
          show_root_heading: true
          show_root_full_path: false
          show_signature_annotations: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          signature_crossrefs: true
          summary: true

theme:
  name: 'material'
  feature:
    tabs: true
  icon:
    repo: fontawesome/brands/github
  features:
  - announce.dismiss
  - content.action.edit
  - content.action.view
  - content.code.annotate
  - content.code.copy
  - content.tooltips
  - navigation.footer
  - navigation.indexes
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - search.highlight
  - search.suggest
  - toc.follow
  palette:
    scheme: slate
    primary: black
    accent: lime

extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/makridenko/supadantic
  - icon: fontawesome/brands/python
    link: https://pypi.org/project/supadantic/

markdown_extensions:
- toc:
    permalink: true
- pymdownx.arithmatex:
    generic: true
- admonition
- pymdownx.keys
- pymdownx.magiclink
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
- pymdownx.tasklist:
    custom_checkbox: true