matchbox/mkdocs.yml at main · uktrade/matchbox · 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
162
163
164
165
166
167
168
169
170
site_name: "Matchbox"
site_description: "Documentation for Matchbox"
repo_url: "https://github.com/uktrade/matchbox"
repo_name: "uktrade/matchbox"

nav:
- Home:
  - Welcome: index.md
  - Use cases: use-cases.md
- Client:
  - Installation: client/install.md
  - Explore DAGs: client/explore-dags.md
  - Look up matches: client/look-up.md
  - Link and deduplicate: client/link-data.md
  - Run DAGs interactively: client/dag-interactive.md
  - Evaluate resolver output: client/evaluation.md
  - API:
    - Overview: api/client/index.md
- Server:
  - Matchbox concepts: server/concepts.md
  - Installation: server/install.md
  - Access control and permissions: server/permissions.md
  - CLI: server/cli.md
  - Data and security risks: server/risks.md
  - API:
    - Overview: api/server/index.md
- Migration:
  - Pre-0.10 to 0.10: migration/pre-0.10-to-0.10.md
- API reference:
  - Client:
    - Overview: api/client/index.md
    - DAGs: api/client/dags.md
    - Locations: api/client/locations.md
    - Sources: api/client/sources.md
    - Queries: api/client/queries.md
    - Models: api/client/models.md
    - Resolvers: api/client/resolvers.md
    - Evaluation: api/client/eval.md
    - Results: api/client/results.md
  - Server:
    - Overview: api/server/index.md
    - API: api/server/api.md
    - Uploads: api/server/uploads.md
    - Backends:
      - PostgreSQL: api/server/backends/postgresql.md
  - Common:
    - Overview: api/common/index.md
    - Database: api/common/db.md
    - Evaluation: api/common/eval.md
    - Exceptions: api/common/exceptions.md
    - Factories:
      - Overview: api/common/factories/index.md
      - Entities: api/common/factories/entities.md
      - Sources: api/common/factories/sources.md
      - Models: api/common/factories/models.md
      - Resolvers: api/common/factories/resolvers.md
      - Scenarios: api/common/factories/scenarios.md
    - Hashing: api/common/hash.md
    - Logging: api/common/logging.md
    - Transform: api/common/transform.md
    - DTOs: api/common/dtos.md
    - Arrow: api/common/arrow.md
- Contributing:
  - Guidelines: contributing.md

theme:
  name: material
  logo: assets/matchbox-icon.svg
  favicon: assets/matchbox-icon-dark.png
  features:
    - content.code.copy
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - attr_list
  - admonition
  - md_in_html
  - smarty
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.blocks.caption
  - toc:
      permalink: true

plugins:
  - search
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          inventories:
          - https://docs.python.org/3/objects.inv
          - https://typing-extensions.readthedocs.io/en/latest/objects.inv
          paths: [src]
          options:
            extensions:
              - griffe_inherited_docstrings
            docstring_options:
              ignore_init_summary: true
            preload_modules: [matchbox]
            docstring_style: google
            docstring_section_style: list
            heading_level: 2
            inherited_members: true
            merge_init_into_class: true
            parameter_headings: true
            separate_signature: true
            show_bases: true
            show_inheritance_diagram: true
            show_root_full_path: false
            show_source: false
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            extra:
              show_docstring_inheritance: true
              show_inheritance: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/uktrade/matchbox
  generator: false

extra_css:
  - stylesheets/extra.css