lazycogs/mkdocs.yml at main · developmentseed/lazycogs · 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
site_name: lazycogs
site_url: https://developmentseed.org/lazycogs/
site_description: Lazy, cloud-native raster mosaics powered by STAC.
repo_url: https://github.com/developmentseed/lazycogs
repo_name: developmentseed/lazycogs

theme:
  name: material
  logo: lazycogs-white.svg
  favicon: favicon.svg
  features:
    - content.code.copy
    - navigation.instant
    - navigation.tracking
    - search.suggest

extra_css:
  - stylesheets/extra.css

nav:
  - Home: index.md
  - Quickstart: notebooks/quickstart.ipynb
  - Guides:
      - STAC item queries: guides/stac-search.md
      - Mosaic methods: guides/mosaic-methods.md
      - Temporal grouping: guides/temporal-grouping.md
      - dtype and nodata handling: guides/dtype-nodata.md
      - Inspecting read plans: notebooks/explain.ipynb
      - Cloud storage: guides/cloud-storage.md
      - Chunking and concurrency: guides/chunking.md
  - Examples:
      - Midwest US daily array: notebooks/demo_midwest_daily.ipynb
      - Southwest US monthly composite: notebooks/demo_southwest_monthly.ipynb
      - NASA HLS:
          - notebooks/hls-https.ipynb
          - notebooks/hls-s3.ipynb
          - notebooks/hls-analysis.ipynb
      - CMR STAC example: notebooks/cmr-lpcloud-fix-assets.ipynb
      - Experimental async workflow: notebooks/async-workflow.ipynb
      - rioxarray interoperability: notebooks/rioxarray.ipynb
      - lazycogs vs odc-stac: notebooks/lazycogs-odc-stac.ipynb
  - Performance: performance.md
  - API Reference:
      - open / open_async: api/open.md
      - Mosaic methods: api/mosaic.md
      - Utilities: api/utils.md
  - Architecture: architecture.md
  - Contributing: CONTRIBUTING.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            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
  - mkdocs-jupyter:
      execute: false
      cache: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.snippets
  - admonition
  - toc:
      permalink: true