mkdocs.yml

site_name: Springtime documentation
repo_url: https://github.com/phenology/springtime
repo_name: Springtime

nav:
  - Home: index.md
  - User guide:
    - Installation: installation.md
    - Intro: user_guide/intro.ipynb
    - Datasets:
      - Overview: user_guide/datasets/overview.md
      - PEP725: user_guide/datasets/pep725.ipynb
      - NPN: user_guide/datasets/npn.ipynb
      - PPO: user_guide/datasets/ppo.ipynb
      - Phenocam: user_guide/datasets/phenocam.ipynb
      - EOBS: user_guide/datasets/eobs.ipynb
      - Daymet: user_guide/datasets/daymet.ipynb
      - MODIS: user_guide/datasets/modis.ipynb
      - Combining data: user_guide/datasets/combining_data.ipynb
      - Adding datasets: user_guide/datasets/adding_datasets.ipynb
    - Modelling:
      - Intro: user_guide/modelling/intro.ipynb
      - Adding: user_guide/modelling/adding_models.ipynb
    - Example use cases:
      - Experiment 1: user_guide/examples/use_case_1.ipynb
      - Experiment 2: user_guide/examples/use_case_2.ipynb
  - Developer guide:
    - Developer Guide: develop.md
    - API Reference: reference/

theme:
  name: material
  logo: lilac_cc0.jpg
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
  icon:
    repo: fontawesome/brands/github
    admonition:
      example: octicons/beaker-16

  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: deep purple
      accent: deep purple

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
      primary: deep purple
      accent: deep purple

plugins:
- mkdocs-jupyter:
    include_source: True
    remove_tag_config:
      remove_input_tags:
        - hide_in_docs
- include-markdown
- search
- mkdocstrings:
    handlers:
      python:
        paths: [src]
        options:
          members_order: source
          show_source: false
          show_signature: true
          inherited_members: true  # https://github.com/mkdocstrings/python/issues/40
          show_if_no_docstring: false
          signature_crossrefs: true
          docstring_section_style: table
          show_submodules: false
          show_root_heading: false
          show_root_toc_entry: false
          show_root_full_path: false
          show_object_full_path: false
          show_symbol_type_heading: true  # currently only available for insiders
        import:
          - https://docs.python.org/3/objects.inv
          - https://docs.pydantic.dev/latest/objects.inv
          - https://geopandas.org/en/stable/objects.inv
          - https://pandas.pydata.org/pandas-docs/stable/objects.inv
          - https://docs.xarray.dev/en/stable/objects.inv
- gen-files:  # Auto-generate API reference files
    scripts:
        - docs/gen_apiref_datasets.py
- literate-nav:  # Create an index for the auto-generated api reference
    nav_file: SUMMARY.md
- section-index
extra:
  generator: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      pygments_lang_class: true
      line_spans: __span
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

watch:
- src

extra_css:
  - "css_api.css"
  - "css_render_xarray.css"
  - "css_hide_edit_button.css"