mkdocs.yml

site_name: GridFIA - Spatial Forest Analysis
site_description: Python API for USDA Forest Service BIGMAP spatial raster analysis
site_author: Christopher Mihiar
site_url: https://mihiarc.github.io/gridfia/

repo_name: gridfia
repo_url: https://github.com/mihiarc/gridfia
edit_uri: edit/main/docs/

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: user-guide/getting-started.md
  - User Guide:
    - Configuration: user-guide/configuration.md
    - Data Pipeline: user-guide/data-pipeline.md
  - API Reference:
    - Overview: api/index.md
    - GridFIA Class: api/gridfia.md
    - Data Models: api/models.md
    - Configuration: api/config.md
    - Calculations: api/calculations.md
    - Processors: api/processors.md
    - Utilities: api/utilities.md
    - Exceptions: api/exceptions.md
  - Tutorials:
    - Species Diversity Analysis: tutorials/species-diversity-analysis.md
  - Architecture:
    - Overview: architecture/overview.md
    - System Design: architecture/system-design.md
  - Contributing: contributing.md

theme:
  name: material
  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)"
      scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: green
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - toc.integrate
    - navigation.top
    - search.highlight
    - search.share
    - header.autohide
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github
    logo: material/forest

plugins:
  - search
  - mermaid2:
      arguments:
        theme: |
          ^(JSON.parse(__md_get("__palette").index == 1)) ? 'dark' : 'light'
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: ["."]
          options:
            docstring_style: google
            docstring_section_style: spacy
            members_order: source
            show_root_heading: true
            show_source: false
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
            merge_init_into_class: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            heading_level: 2
            filters: ["!^_"]

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: mihiarc
      repo: gridfia
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mihiarc/gridfia
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/gridfia/
  # SEO meta tags for better discoverability
  meta:
    - name: keywords
      content: gridfia, python, forestry, biomass, USDA, FIA, BIGMAP, zarr, species diversity, forest inventory, geospatial, remote sensing, ecological modeling
    - name: author
      content: Christopher Mihiar, USDA Forest Service
    - property: og:title
      content: GridFIA - Python API for Spatial Forest Analysis
    - property: og:description
      content: Efficient Zarr-based storage and processing for USDA Forest Service BIGMAP forest biomass data. Calculate species diversity indices and create publication-ready maps.
    - property: og:type
      content: website
    - property: og:url
      content: https://mihiarc.github.io/gridfia/
    - property: og:site_name
      content: GridFIA Documentation
    - name: twitter:card
      content: summary_large_image
    - name: twitter:title
      content: GridFIA - Python API for Spatial Forest Analysis
    - name: twitter:description
      content: Python API for USDA Forest Service BIGMAP spatial raster analysis. Forest biomass and species diversity at 30m resolution.

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js