dataorc/mkdocs.yml at main · equinor/dataorc · 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
site_name: DataOrc Documentation
site_description: Unified documentation for DataOrc packages
site_url: https://equinor.github.io/dataorc/
repo_url: https://github.com/equinor/dataorc
repo_name: equinor/dataorc
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.png  # Path to your logo file
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: green
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.suggest

plugins:
  - search
  - git-revision-date-localized:
      fallback_to_build_date: true

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  # Enable the Snippets extension to add the ability to embed content from
  # external files.
  # Ref: https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets
  - pymdownx.highlight:
      anchor_linenums: true
      linenums_style: table
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets

nav:
  - Home: index.md
  - User guide:
    - Packages:
      - dataorc-utils:
        - Config:
          - Overview: packages/dataorc-utils/config/index.md
          - CorePipelineConfig: packages/dataorc-utils/config/core_pipeline_config.md
          - PipelineParameterManager: packages/dataorc-utils/config/pipeline_parameter_manager.md
          - Defaults and validation: packages/dataorc-utils/config/defaults_and_validation.md
        - Lake:
          - Overview: packages/dataorc-utils/lake/index.md
        - Databricks:
          - Overview: packages/dataorc-utils/databricks/index.md
          - Mounts: packages/dataorc-utils/databricks/mounts.md
          - Parameters: packages/dataorc-utils/databricks/parameters.md
        - Azure:
          - Key Vault: packages/dataorc-utils/azure/azure_keyvault.md
  - Changelog: changelog/index.md