sen4cap-client/mkdocs.yml at main · Sen4CAP/sen4cap-client · 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
#  Copyright (c) 2025 by ESA Sen4CAP 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 Sen4CAP Client
repo_url: https://github.com/Sen4CAP/sen4cap-client
repo_name: sen4cap-client

copyright: Copyright &copy; 2025 ESA Sen4CAP Team

nav:
  - Overview: index.md
  - Installation: installation.md
  - User Guides:
        - notebooks/client-gui.ipynb
        - notebooks/client-api.ipynb
        - notebooks/client-cli.ipynb
  - CLI Reference: cli.md
  - API Reference: api.md
  - Contributing: contributing.md

theme:
  name: material
  logo: assets/icon.png
  favicon: assets/favicon.ico
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: blue grey
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: blue grey
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.top
  custom_dir: docs/overrides

markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - 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/Sen4CAP/sen4cap-client
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/sen4cap-client/

plugins:
  - search
  - autorefs
  - mkdocs-jupyter
  - 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

extra_css:
    - overrides/css/custom.css

hooks:
    - docs/hooks/notebooks_json_output.py