mkdocs.yml

site_name: UK EODH Documentation
site_url: https://eodatahub.org.uk/docs/documentation
theme:
  name: material
  custom_dir: docs/overides
  font:
    text: Fira Sans #Atkinson Hyperlegible
  logo: assets/icon_eodh_logo_white_grey.png #logo.svg
  features:
    - navigation.footer
    - content.code.copy
    - content.code.select
  palette:
    # Dark Mode
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Dark mode
      primary: blue grey
      accent: orange

    # Light Mode
    - scheme: default
      toggle:
        icon: material/weather-night
        name: Light mode
      primary: blue
      accent: blue

nav:
  - Home: index.md
  - Getting Started:
    - Account types: Getting-Started/access-levels.md
    - Creating a user account: Getting-Started/user-accounts.md
    - Getting a billing account: Getting-Started/billing-accounts.md
    - Workspaces:
      - Creating a workspace: Getting-Started/workspaces/create-workspace.md
      - Managing workspace members: Getting-Started/workspaces/member-management.md
      - Workspace credentials: Getting-Started/workspaces/workspace-credentials.md
      - Linked accounts: Getting-Started/workspaces/linked-accounts.md
  - Explore:
    - Finding data: 
      - Searching for data: Explorers/resource-catalogue/data-discovery.md
      - Understanding metadata: Explorers/resource-catalogue/metadata.md
      - Understanding data quality: Explorers/resource-catalogue/quality-assessment.md
    - Downloading data: Explorers/resource-catalogue/downloading-data.md
    - Visualising data: Explorers/resource-catalogue/visualising-data.md
    - Running workflows and notebooks: Explorers/resource-catalogue/run_workflow_notebooks.md
    - GIS plugins: Explorers/access-points/GIS.md
    - Code access: Explorers/access-points/code.md
  - Analyse:
    - Commercial data:
      - Linking into EODH: Analysts/commercial/link-accounts.md
      - Ordering commercial data: Analysts/commercial/ordering-commercial-data.md
      - Ordering commercial SAR data: Analysts/commercial/understanding-sar-ordering-options.md
      - Usage restrictions: Analysts/commercial/restrictions.md
    - Notebook service:
      - Using notebooks: Analysts/notebook-service/notebooks-start.md
      - Integrating with git: Analysts/notebook-service/git-integration.md
      - Practical tips: Analysts/notebook-service/practical-tips.md
    - Platform APIs:
      - API introduction: Analysts/APIs/api-intro.md
      - API examples: Analysts/APIs/api-examples.md
    - TiTiler visualisation:
      - TiTiler introduction: Analysts/visualisation/introduction.md
      - Preparing data: Analysts/visualisation/preparing-data.md
      - Serving data: Analysts/visualisation/serving-data.md
      - Configuring requests: Analysts/visualisation/configuring-requests.md
      - TiTiler endpoints: Analysts/visualisation/endpoints.md
      - Additional tools: Analysts/visualisation/third-party-tools.md
  - Develop: 
    - Tools:
      - pyeodh: Developers/tools/pyeodh.md
      - eoap-gen: Developers/tools/eoap.md 
      - dask: Developers/tools/dask.md
    - Data publishing:
      - S3 credentials: Developers/s3-credentials/s3-credentials.md
      - Pushing data onto the Hub: Developers/data-publishing/data-publishing.md 
    - Apps:
      - Understanding apps: Developers/apps/apps.md
      - Understanding billing: Developers/apps/billing.md
      - Creating an app: Developers/apps/creating-an-app.md
      - Using workflows: Developers/apps/workflows-and-user-servces.md
    - Workflow runner:
      - Application packages: Developers/workflow-runner/application-packages.md
  - Example notebooks:
    - Dedicated walk-through:
      - Set-up: training-materials/walkthrough/0_202502_setup.ipynb
      - Discovering data: training-materials/walkthrough/1_202502_discovery.ipynb
      - Processing data: training-materials/walkthrough/2_202502_processing.ipynb
      - Visualising data: training-materials/walkthrough/3_202502_datavis.ipynb
    - Commercial data quotes and orders: training-materials/examples/commercial.ipynb
    - Data cubes: training-materials/examples/datacubes.ipynb
    - Why use pyeodh over pystac?: training-materials/examples/pyeodh-vs-pystac.ipynb
    - Using dask on the Hub: training-materials/examples/dask_example.ipynb
    - Polar ocean temperatures and sea ice thickness: training-materials/examples/polar.ipynb
    - EOCIS land surface temperature data: training-materials/examples/mapping-lst-uk.ipynb
    - Handling timeseries data: training-materials/examples/timeseries.ipynb
    - Finding windfarms: training-materials/examples/finding_windfarms.ipynb
    - EOAP SAR Coherence: training-materials/workflows/4_SAR_coherence.ipynb
    - EOAP Temporal Mosaics: training-materials/workflows/5_temp_mos.ipynb
  - Additional help:
    - FAQs: Help/faqs.md
    - Community support: Help/community.md
    - Video demonstrations: Help/videos.md


extra:
  homepage: https://eodatahub.org.uk/
extra_javascript:
  - javascripts/extra.js
extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - mkdocs-jupyter:
      include_source: True