mkdocs.yml

site_name: pyramids
site_description: GIS package
site_url: https://serapeum-org.github.io/pyramids/
repo_url: https://github.com/serapeum-org/pyramids
repo_name: serapeum-org/pyramids

theme:
  name: material
  language: en
  features:
    - navigation.instant
    - navigation.tracking
    # - navigation.expand
    # - navigation.indexes
    - navigation.footer
    # - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - content.tooltips
    - search.highlight
    - search.suggest
    - toc.follow
    - announce.dismiss
  palette:
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: teal
    accent: purple
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    accent: lime
    toggle:
      icon: material/weather-night
      name: Switch to system preference
  primary: indigo
  accent: indigo
  icon:
    repo: fontawesome/brands/github


plugins:
  - search
  - mkdocs-jupyter:
      include_source: true
      execute: false
  - panzoom:
      hint_location: "top"
      key: "ctrl"
      full_screen: true
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2
            docstring_style: google
  - table-reader
  - tags
  - mike:
      # These fields are all optional; the defaults are as below...
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - footnotes
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: "#"
      toc_depth: 1-4
      anchorlink: true

nav:
  - Home: index.md
  - Installation: installation.md
  - Overview:
    - Codebase Map: overview/codebase-map.md
    - How it works: overview/how-it-works.md
    - Architecture: overview/architecture.md
  - Architecture:
    - Diagrams: architecture/diagrams.md
  - Reference:
    - Dataset:
      - Overview: reference/dataset/index.md
      - I/O Operations: reference/dataset/io.md
      - Spatial Operations: reference/dataset/spatial.md
      - Analysis Operations: reference/dataset/analysis.md
      - Vectorize Operations: reference/dataset/vectorize.md
      - Band Metadata Operations: reference/dataset/band_metadata.md
      - Cell Operations: reference/dataset/cell.md
    - DatasetCollection: reference/dataset_collection.md
    - Feature:
      - Overview: reference/feature/index.md
      - Geometry helpers: reference/feature/geometry.md
    - CRS helpers: reference/base/crs.md
    - NetCDF:
      - NetCDF Class: reference/netcdf/index.md
      - Plotting: reference/netcdf/plot.md
      - Data Models: reference/netcdf/models.md
      - Metadata: reference/netcdf/metadata.md
      - Dimensions: reference/netcdf/dimensions.md
      - Utilities: reference/netcdf/utils.md
      - CF Conventions: reference/netcdf/cf/index.md
      - UGRID:
        - Overview: reference/netcdf/ugrid/index.md
        - UgridDataset: reference/netcdf/ugrid/dataset.md
        - Mesh2d: reference/netcdf/ugrid/mesh.md
        - Connectivity: reference/netcdf/ugrid/connectivity.md
        - Spatial Operations: reference/netcdf/ugrid/spatial.md
        - Interpolation: reference/netcdf/ugrid/interpolation.md
        - I/O: reference/netcdf/ugrid/io.md
        - Data Models: reference/netcdf/ugrid/models.md
        - Visualization: reference/netcdf/ugrid/plot.md
    - config: reference/config.md
  - Examples:
      - Lazy / Dask:
          - Overview: tutorials/lazy/lazy-compute.md
          - Lazy rasters (Dataset): tutorials/lazy/lazy-raster.md
          - Lazy NetCDF: tutorials/lazy/lazy-netcdf.md
          - Lazy collections (DatasetCollection): tutorials/lazy/lazy-collection.md
          - Lazy vector reads (FeatureCollection): tutorials/lazy/lazy-vector.md
      - Dataset:
          - Overview: tutorials/dataset.md
          - Raster basics: tutorials/raster-basics.md
          - Datacube basics: tutorials/datacube-basics.md
          - Dataset basics: examples/dataset/dataset.ipynb
          - Spatial operations: examples/dataset/spatial-operation-methods.ipynb
          - Convert longitude: examples/dataset/convert-longitude.ipynb
          - DatasetCollection (guide): tutorials/dataset_collection.md
          - Dataset collection: examples/dataset/dataset_collection.ipynb
          - South America: examples/dataset/south-america.ipynb
          - Cloud Optimized GeoTIFFs: tutorials/cog.md
          - Dask (Sentinel-2 COGs on AWS): examples/dataset/dask-lazy-datasets.ipynb
          - Dask — Dataset (local data): examples/dataset/lazy-dataset-complete.ipynb
          - Dask — DatasetCollection (local data): examples/dataset/lazy-collection-complete.ipynb
      - Feature:
          - FeatureCollection tutorial: tutorials/feature.md
          - Dask (Overture Maps on AWS): examples/feature/dask-lazy-features.ipynb
          - Dask — LazyFeatureCollection (local data): examples/feature/lazy-feature-complete.ipynb
      - Basemap:
          - Basemap example: examples/basemap/basemap-example.ipynb
      - NetCDF:
          - Plotting NetCDF data: tutorials/netcdf-plotting.md
          - Dask (ERA5 on AWS): examples/netcdf/dask-lazy-netcdf.ipynb
          - Dask — NetCDF (local data): examples/netcdf/lazy-netcdf-complete.ipynb
          - UGRID:
              - Mesh exploration: examples/netcdf/ugrid/ugrid-mesh-exploration.ipynb
              - River channel: examples/netcdf/ugrid/ugrid-river-channel.ipynb
              - Dask (FVCOM NECOFS via OPeNDAP): examples/netcdf/ugrid/dask-lazy-ugrid.ipynb
  - How-to:
      - Dev Container: how-to/devcontainer.md
      - Docker & GHCR: how-to/docker.md
      - Recipes: how-to/recipes.md
      - Testing & CI: how-to/testing.md
      - FAQ & Troubleshooting: how-to/faq.md
  - About:
    - Change-log: change-log.md
    - Code of Conduct: CODE_OF_CONDUCT.md
    - Contributing: contributing.md
    - License: LICENSE.md
    - Authors: AUTHORS.md
    - ADRs:
        - Index: adr/index.md
        - ADR-0001 Docs stack: adr/0001-docs-stack.md
        - ADR-0002 Type checking: adr/0002-type-checking.md
        - ADR-0003 IO formats: adr/0003-io-formats.md
        - ADR-0004 Dependency graphing: adr/0004-dependency-graphing.md
        - ADR-0005 Versioning docs: adr/0005-versioning-docs.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/serapeum-org/pyramids
  version:
      provider: mike
  version_selector: true