type-bridge/mkdocs.yml at master · ds1sqe/type-bridge · 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
site_name: TypeBridge
site_url: https://ds1sqe.github.io/type-bridge/
site_description: A modern, Pythonic ORM for TypeDB with an Attribute-based API
site_author: ds1sqe
repo_url: https://github.com/ds1sqe/type-bridge
repo_name: ds1sqe/type-bridge
edit_uri: edit/master/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            show_if_no_docstring: false
            signature_crossrefs: true
            separate_signature: true
            heading_level: 2
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - attr_list
  - md_in_html

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
  - User Guide:
    - guide/index.md
    - Attributes: guide/attributes.md
    - Entities: guide/entities.md
    - Relations: guide/relations.md
    - Abstract Types: guide/abstract-types.md
    - Cardinality & Flags: guide/cardinality.md
    - CRUD Operations: guide/crud.md
    - Queries & Expressions: guide/queries.md
    - Schema Management: guide/schema.md
    - Code Generator: guide/generator.md
    - API DTOs: guide/dto.md
    - Functions: guide/functions.md
    - Validation: guide/validation.md
    - Logging: guide/logging.md
  - API Reference: reference/
  - Development:
    - development/index.md
    - Development Setup: development/setup.md
    - Testing: development/testing.md
    - TypeDB Concepts: development/typedb.md
    - Abstract Types: development/abstract-types.md
    - Internals: development/internals.md
  - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ds1sqe/type-bridge
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/type-bridge/