gaiaflow/mkdocs.yml at main · bcdev/gaiaflow · 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
site_name: GaiaFlow - MLOps tool streamlining Earth Observation ML projects.
repo_url: https://github.com/bcdev/gaiaflow
repo_name: bc-dev/gaiaflow

copyright: Copyright &copy; 2025 Brockmann Consult

nav:
  - Overview: index.md
  - Getting Started: start.md
  - User guide - dev and dev_docker: dev_guide.md
  - User guide - prod_local and prod: prod_guide.md
  - CLI reference: cli_ref.md

# TODO: Infrastrucutre architecutre
# create_task: behaviour by environments
# From_Task explanation
# dev_docker
# How to create
#  CDR,
#  CDR_PAT,
#  S3,
#  AWS roles,
#  docker image name and push,
#  secrets
#  github repo to be added by infra team,
#  user to be created in airflow by infra team
# Add CI for PyPi and testing
# Release 0.0.1 in pypi

# Cookiecutter
# Remove all lib stuff
# Update CI
# Use 0.0.1 here instead.
# Update examples with create_task

# Test on windows
# Add tests
# Use pixi
# Model deployment
# K8s pod-spec
# stage-in/stage-out

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: lightblue
      accent: purple
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: lightblue
      accent: lime
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

extra:
  mermaid: true
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bcdev/gaiaflow

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_root_toc_entry: true
            show_root_heading: true
            show_source: true
            heading_level: 2
            annotations_path: brief
            members_order: source