seaview/mkdocs.yml at main · brorfred/seaview · 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
114
site_name: Seaview Documentation
site_description: Documentation for the Seaview oceanographic data processing and tile generation system
site_author: Seaview Team
repo_url: https://github.com/your-org/seaview
repo_name: seaview

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: light blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: light blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src, .]
          options:
            docstring_style: numpy
            docstring_options:
              ignore_init_summary: false
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            heading_level: 2
            merge_init_into_class: true
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - pymdownx.mark
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Configuration: getting-started/configuration.md
    - Quick Start: getting-started/quickstart.md
  - User Guide:
    - Overview: user-guide/overview.md
    - Data Sources: user-guide/data-sources.md
    - Tile Generation: user-guide/tile-generation.md
    - Layer Configuration: user-guide/layer-config.md
  - API Reference:
    - Overview: api/index.md
    - seaview: api/processor.md
    - seaview.config: api/config.md
    - seaview.tile: api/tile.md
    - seaview.layer_config: api/layer_config.md
    - seaview.area_definitions: api/area_definitions.md
    - seaview.cli: api/cli.md
    - Data Sources:
      - seaview.data_sources.cmems_ssh: api/data_sources/cmems_ssh.md
      - seaview.data_sources.ostia: api/data_sources/ostia.md
      - seaview.data_sources.globcolour: api/data_sources/globcolour.md
      - seaview.data_sources.gebco_bathy: api/data_sources/gebco_bathy.md
      - seaview.data_sources.olci_L2: api/data_sources/olci_L2.md
    - Readers:
      - seaview.readers.copernicus_ssh: api/readers/copernicus_ssh.md
    - Tilers:
      - seaview.tilers.rectlinear: api/tilers/rectlinear.md
      - seaview.tilers.utils: api/tilers/utils.md
    - Utilities:
      - shiptrack: api/shiptrack.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/your-org/seaview

copyright: Copyright &copy; 2024-2026 Seaview Team