groundworkers/mkdocs.yaml at main · AustralianCancerDataNetwork/groundworkers · 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: groundworkers
site_description: Read-only OMOP tooling for MCP and direct Python services
site_url: https://AustralianCancerDataNetwork.github.io/groundworkers
repo_url: https://github.com/AustralianCancerDataNetwork/groundworkers
repo_name: groundworkers

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - content.code.copy
    - content.code.annotate
  palette:
    - scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: light-blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Architecture: architecture.md
  - Getting Started:
      - Installation: usage/installation.md
      - Configuration: usage/configuration.md
      - Integrations: usage/integrations.md
      - Testing: usage/testing.md
  - Development:
      - Extending groundworkers: development/extending.md
  - Tools:
      - Overview: tools/overview.md
      - Concept Tools: tools/concept.md
      - Resolver Tools: tools/resolver.md
      - Search Tools: tools/search.md
      - Mapping Tools: tools/mapping.md
      - Embedding Tools: tools/embedding.md
      - Text Tools: tools/text.md
      - Domain Tools: tools/domain.md
      - System Tools: tools/system.md
  - Services:
      - Graph Service: services/graph.md
      - Grounding Service: services/grounding.md
      - Vocab Service: services/vocab.md
      - Mapping Service: services/mapping.md
      - Source Planning Service: services/source_planning.md
      - Text Service: services/text.md
      - Domain Service: services/domain.md
  - Adapters:
      - CDM: adapters/cdm.md
      - OmopGraph: adapters/omop_graph.md
      - OmopEmb: adapters/omop_emb.md
  - API Reference:
      - Tools: reference/ref_tools.md
      - Services: reference/ref_services.md
      - Adapters: reference/ref_adapters.md
      - Configuration: reference/ref_config.md
      - Base: reference/ref_base.md

plugins:
  - search
  - mermaid2
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_root_heading: true
            show_source: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - tables
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid