SRGAN/mkdocs.yml at main · ESAOpenSR/SRGAN · 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
site_name: "SRGAN Docs"
site_description: "OpenSR-SRGAN: Flexible Super-Resolution GANs for satellite imagery"
site_url: https://srgan.opensr.eu/
copyright: "2024-2025, Simon Donike et al."
repo_url: https://github.com/ESAOpenSR/SRGAN
repo_name: ESAOpenSR/SRGAN
edit_uri: edit/main/docs/

docs_dir: docs

theme:
  name: material
  favicon: assets/favicon.png
  #favicon: assets/favicon.png
  features:
    - navigation.tabs        # <- top tabs
    - navigation.sections    # sidebar sections
    - navigation.indexes     # use section index pages (api-reference/index.md)
    - navigation.tabs.sticky
    - navigation.instant
    - navigation.sections
    - content.code.copy
    - toc.integrate
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: auto
            show_source: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      linenums_style: pymdownx-inline
  - pymdownx.snippets:
      base_path:
        - .
        - ./docs
        - ..
      check_paths: true
      encoding: utf-8

  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.details
  - pymdownx.tasklist
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true

edit_uri: edit/main/docs/

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js


extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ESAOpenSR/SRGAN
  generator: false

nav:
  - Overview:
      - SRGAN Docs: index.md
      - Getting Started: getting-started.md
      - Results: results.md

  - Usage:
      - Inference Guide: inference.md
      - HPC Inference: hpc-inference.md
      - Configuration: configuration.md
      - Data Preparation: data.md

  - Training:
      - Training Workflow: training.md
      - Trainer Details: trainer-details.md
      - Training Guideline: training-guideline.md
      - Architecture: architecture.md

  - API reference:
      - Overview: api-reference/index.md
      - Inference API: api-reference/inference.md
      - Training API: api-reference/training.md
      - Model Components: api-reference/model.md
      - Data Pipeline: api-reference/data.md
      - Utility Helpers: api-reference/utils.md