s2gos-controller/mkdocs.yml at main · s2gos-dev/s2gos-controller · 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
#  Copyright (c) 2025-2026 by ESA DTE-S2GOS team and contributors
#  Permissions are hereby granted under the terms of the Apache 2.0 License:
#  https://opensource.org/license/apache-2-0.

site_name: ESA DTE-S2GOS Controller
repo_url: https://github.com/s2gos-dev/s2gos-controller
repo_name: s2gos-dev/s2gos-controller

copyright: Copyright &copy; 2025-2026 ESA DTE-S2GOS Team

nav:
  - What is it?: index.md
  - Installation: installation.md
  - User Guide:
    - notebooks/client-api.ipynb
    - notebooks/client-api-airflow.ipynb
    - notebooks/client-gui.ipynb
    - notebooks/client-cli.ipynb
  - References:
    - Client API Reference: client-api.md
    - Client CLI Reference: client-cli.md
    - Execution Requests: execution-requests.md
  - Development:
    - Contributing: contributing.md
    - Roadmap: roadmap.md

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.ico
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: 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
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.top
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - toc.follow
    - content.code.copy
  custom_dir: docs/overrides

markdown_extensions:
  - attr_list
  - tables
  - admonition
  - pymdownx.details
  # - pymdownx.highlight
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/s2gos-dev/s2gos-controller
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/s2gos-client/
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/s2gos-server/

plugins:
  - search
  - autorefs
  - mkdocs-jupyter
  - mkdocstrings:
      handlers:
        python:
          options:
            #annotations_path: brief
            #annotations_path: full
            annotations_path: source
            docstring_style: google
            docstring_section_style: table
            filters:
              - "!^_"
            heading_level: 3
            inherited_members: true
            line_length: 80
            members_order: source
            merge_init_into_class: true
            separate_signature: true
            show_if_no_docstring: false
            show_root_heading: true
            show_root_toc_entry: true
            show_signature_annotations: true
            show_source: false
            # --- Generates JSON schema doc for each pydantic model:
            # extensions:
            #  - griffe_pydantic:
            #      schema: true
extra_css:
  - overrides/css/custom.css

hooks:
  - docs/hooks/notebooks_json_output.py