xcube-eopf/mkdocs.yml at main · EOPF-Sample-Service/xcube-eopf · 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
site_name: EOPF xcube data store
repo_url: https://github.com/EOPF-Sample-Service/xcube-eopf
repo_name: EOPF-Sample-Service/xcube-eopf

copyright: Copyright &copy; 2025 EOPF Sample Service Team

nav:
  - Overview: index.md
  - Getting Started: start.md
  - User Guide: guide.md
  - Python API: api.md
  - About: about.md

theme:
  name: material
  # logo: assets/logo.png
  # favicon: assets/logo-small.png
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: blue grey
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: blue grey
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

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

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/EOPF-Sample-Service/xcube-eopf
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/xcube-eopf/

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