VirtualiZarr/mkdocs.yml at c2fcb6c4bd7898653a9a129d67f56516e46d85cb · maxrjones/VirtualiZarr · 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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# Based on https://github.com/developmentseed/obspec/blob/main/mkdocs.yml
site_name: VirtualiZarr
repo_name: zarr-developers/VirtualiZarr
repo_url: https://github.com/zarr-developers/VirtualiZarr
site_description: Cloud-Optimize your Scientific Data as Virtual Zarr stores, using Xarray syntax.
site_author: VirtualiZarr developers
site_url: !ENV [READTHEDOCS_CANONICAL_URL, 'https://virtualizarr.readthedocs.io/en/latest/']
docs_dir: docs
use_directory_urls: false

extra:
  version:
    alias: true
    provider: mike

nav:
  - "index.md"
  - Getting started:
    - "installation.md"
  - How-to guides:
    - "usage.md"
    - "examples.md"
  - Explanation:
    - "data_structures.md"
    - "custom_parsers.md"
    - "scaling.md"
    - "faq.md"
  - API Reference:
    - api/virtualizarr.md
    - Parsers:
      - api/parsers/protocol.md
      - api/parsers/hdf5.md
      - api/parsers/fits.md
      - api/parsers/kerchunk.md
      - api/parsers/netcdf3.md
      - api/parsers/zarr.md
      - api/parsers/dmrpp.md
      - api/parsers/tiff.md
    - api/serialization.md
    - api/developer.md
  - "migration_guide.md"
  - About the project:
    - "releases.md"
    - "contributing.md"
    - "core_team_guide.md"
watch:
  - virtualizarr
  - docs
  - mkdocs.yml
  - pyproject.toml

theme:
  language: en
  name: material
  custom_dir: docs/overrides
  # logo: assets/logo_no_text.png
  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
      # accent: deep orange
      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
      # accent: deep orange
      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
  - autorefs
  - markdown-exec
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          paths: [virtualizarr]
          options:
            allow_inspection: false
            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://docs.xarray.dev/en/stable/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://numcodecs.readthedocs.io/en/stable/objects.inv
            - https://zarr.readthedocs.io/en/stable/objects.inv
            - https://obspec-utils.readthedocs.io/en/stable/objects.inv
            - https://developmentseed.org/obstore/latest/objects.inv
            - https://filesystem-spec.readthedocs.io/en/latest/objects.inv
            - https://requests.readthedocs.io/en/latest/objects.inv
            - https://docs.aiohttp.org/en/stable/objects.inv
            - https://s3fs.readthedocs.io/en/latest/objects.inv
            - https://docs.h5py.org/en/stable/objects.inv
            - https://icechunk.io/en/stable/objects.inv
            - https://lithops-cloud.github.io/docs/objects.inv
            - https://docs.dask.org/en/stable/objects.inv
# https://github.com/developmentseed/titiler/blob/50934c929cca2fa8d3c408d239015f8da429c6a8/docs/mkdocs.yml#L115-L140
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.tabbed:
      alternate_style: true
  - pymdownx.tilde
  - toc:
      permalink: true