geozarr-examples/mkdocs.yml at main · developmentseed/geozarr-examples · 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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
site_name: geozarr-examples
repo_name: developmentseed/geozarr-examples
repo_url: https://github.com/developmentseed/geozarr-examples
site_description: GeoZarr convention models, utilities, and examples
site_author: Max Jones
docs_dir: docs
site_url: !ENV [READTHEDOCS_CANONICAL_URL, "https://developmentseed.org/geozarr-examples/"]

extra:
  version:
    alias: true
    provider: mike

nav:
  - "About": "index.md"
  - "Examples":
  #   - "Using the Library": "examples/utility/07_using_geozarr_examples_library.ipynb"
  #   - "Download Data": "examples/utility/00_download_data.ipynb"
  #   - "Spatial Convention":
  #     - "GeoTransform": "examples/spatial/02_CRS_and_geotransform_in_auxiliary_variable.ipynb"
    - "Proj Convention": "examples/proj-convention.ipynb"
    - "Inheritance": "examples/inheritance.ipynb"
    - "Composition": "examples/composition.ipynb"
    - "COG to Zarr": "examples/cog-to-zarr.ipynb"
  #   - "Multiscales Convention":
  #     - "WebMercatorQuad (Zarr V2)": "examples/multiscales/03_multiscales_as_WebMercatorQuad_ZarrV2.ipynb"
  #     - "WebMercatorQuad (Zarr V3)": "examples/multiscales/04_multiscales_as_WebMercatorQuad_ZarrV3.ipynb"
  #   - "CF Convention":
  #     - "CF Basics": "examples/cf/01_cf_basics.ipynb"
  #     - "CF Grid Mapping": "examples/cf/02_cf_grid_mapping.ipynb"
  #     - "Composed Conventions": "examples/cf/03_cf_composed_conventions.ipynb"
  #   - "Utility":
  #     - "STAC Metadata": "examples/utility/06_embedded_STAC_block.ipynb"

watch:
  - docs

theme:
  language: en
  name: material
  custom_dir: docs/overrides
  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)"
      primary: blue grey
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  font:
    text: Roboto
    code: Roboto Mono

  features:
    - content.code.annotate
    - content.code.copy
    - navigation.indexes
    - navigation.instant
    - navigation.tracking
    - search.suggest
    - search.share

extra_css:
  - overrides/stylesheets/extra.css

plugins:
  - search
  - markdown-exec
  - mkdocs-jupyter:
      include_source: true
      execute: false
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          paths: [src]
          options:
            allow_inspection: true
            docstring_section_style: list
            docstring_style: numpy
            line_length: 80
            separate_signature: true
            show_root_heading: true
            show_signature_annotations: true
            show_source: false
            show_symbol_type_toc: true
            signature_crossrefs: true

          inventories:
            - https://docs.python.org/3/objects.inv
            - https://zarr.readthedocs.io/en/stable/objects.inv

markdown_extensions:
  - admonition
  - attr_list
  - codehilite:
      guess_lang: false
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.arithmatex
  - pymdownx.betterem
  - pymdownx.caret:
      insert: false
  - pymdownx.details
  - pymdownx.escapeall:
      hardbreak: true
      nbsp: true
  - pymdownx.magiclink:
      hide_protocol: true
      repo_url_shortener: true
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - toc:
      permalink: true