orm-loader/mkdocs.yml at main · AustralianCancerDataNetwork/orm-loader · 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
site_name: orm-loader
site_description: Infrastructure primitives for SQLAlchemy-based data models
site_url: https://AustralianCancerDataNetwork.github.io/orm-loader/
repo_url: https://github.com/AustralianCancerDataNetwork/orm-loader
repo_name: orm-loader

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - navigation.path
    - content.code.copy

markdown_extensions:
  - admonition
  - footnotes
  - tables
  - attr_list
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - toc:
      permalink: true

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
  - js/mermaid-init.js

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            show_source: false
            docstring_style: numpy

nav:
  - Home: index.md
  - Tables:
      - Overview: tables/index.md
      - ORMTableBase: tables/orm_table.md
      - SerialisableTableInterface: tables/serialisable_table.md
      - Loadable Tables: tables/loadable_table.md
      - IdAllocator: tables/allocators.md
      - Typing Protocols: tables/typing.md
      - Materialised Views: tables/mat_view.md
  - Registry & Validation:
      - Overview: registry/index.md
      - Model Registry: registry/registry.md
      - Validation Rules: registry/validation.md
      - Validation Runner: registry/validation_runner.md
      - Validation Report: registry/validation_report.md
      - Model Descriptors: registry/descriptors.md
  - Loaders:
      - Overview: loaders/index.md
      - Loader Context & Diagnostics: loaders/context.md
      - Loader Implementations: loaders/loaders.md
      - Loader Helpers: loaders/helpers.md