ferro-orm/mkdocs.yml at main · syn54x/ferro-orm · 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
site_name: Ferro ORM
site_description: A high-performance, Rust-backed, Pydantic driven ORM for Python.
site_url: https://syn54x.github.io/ferro-orm/
repo_url: https://github.com/syn54x/ferro-orm
edit_uri: edit/main/docs/

watch:
  - src
  - docs

extra_css:
  - stylesheets/extra.css

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: light-rust
      primary: custom
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - llmstxt:
      markdown_description: Ferro is a high-performance, Rust-backed ORM for Python with a familiar Pydantic-style API.
      full_output: llms-full.txt
      sections:
        Getting Started:
          - getting-started/installation.md
          - getting-started/tutorial.md
          - getting-started/next-steps.md
        User Guide:
          - guide/models-and-fields.md
          - guide/relationships.md
          - guide/queries.md
          - guide/mutations.md
          - guide/transactions.md
          - guide/database.md
          - guide/migrations.md
        How-To:
          - howto/pagination.md
          - howto/testing.md
          - howto/timestamps.md
          - howto/soft-deletes.md
          - howto/multiple-databases.md
        Concepts:
          - concepts/architecture.md
          - concepts/identity-map.md
          - concepts/type-safety.md
          - concepts/performance.md
        API Reference:
          - api/*.md
        Community:
          - faq.md
          - contributing.md
          - changelog.md
          - coming-soon.md
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_category_heading: true
            show_if_no_docstring: true
            members_order: source

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path: ["."]
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Why Ferro?: why-ferro.md

  - Getting Started:
      - Installation: getting-started/installation.md
      - Tutorial: getting-started/tutorial.md
      - Next Steps: getting-started/next-steps.md

  - User Guide:
      - Models & Fields: guide/models-and-fields.md
      - Relationships: guide/relationships.md
      - Queries: guide/queries.md
      - Mutations: guide/mutations.md
      - Transactions: guide/transactions.md
      - Database Setup: guide/database.md
      - Schema Management: guide/migrations.md

  - How-To:
      - Pagination: howto/pagination.md
      - Testing: howto/testing.md
      - Timestamps: howto/timestamps.md
      - Soft Deletes: howto/soft-deletes.md
      - Multiple Databases: howto/multiple-databases.md

  - Concepts:
      - Architecture: concepts/architecture.md
      - Identity Map: concepts/identity-map.md
      - Type Safety: concepts/type-safety.md
      - Performance: concepts/performance.md

  - API Reference:
      - Model: api/model.md
      - Query: api/query.md
      - Fields: api/fields.md
      - Relationships: api/relationships.md
      - Transactions: api/transactions.md
      - Utilities: api/utilities.md

  - Community:
      - FAQ: faq.md
      - Contributing: contributing.md
      - Changelog: changelog.md
      - Coming Soon: coming-soon.md