mkdocs.yml

site_name: HyP3
site_url: https://hyp3-docs.asf.alaska.edu/
site_author: ASF APD/Tools Team
site_description: The Alaska Satellite Facility's Hybrid Pluggable Processing Pipeline

# ASF's Google Analytics
google_analytics:
  - UA-991100-5
  - search.asf.alaska.edu

theme:
  name: asf-theme
  custom_dir: overrides
  logo: images/HyP3-graphic-only.png
  icon:
    repo: fontawesome/brands/github-alt
  features:
    # - navigation.instant  # This doesn't work with the NASA Earthdata tophat; see ASFHyP3/hyp3-docs#371
    - navigation.footer
    - announce.dismiss

repo_url: https://github.com/ASFHyP3
repo_name: ASF HyP3
edit_uri: ''

extra:
  social:
    - icon: fontawesome/brands/gitter
      link: https://gitter.im/ASFHyP3/community

markdown_extensions:
  - toc:
      permalink: true
      toc_depth: 4
  - attr_list
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Using HyP3:
    - using.md
    # TODO TOOL-2787: uncomment this line:
    #- Requesting Access: using/requesting_access.md
    - Vertex: using/vertex.md
    - SDK:
      - using/sdk.md
      - Example Notebook: https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-sdk/blob/main/docs/sdk_example.ipynb" target="_blank
      - API Reference: using/sdk_api.md
    - API: using/api.md
    - Credits: using/credits.md
    - Subscriptions: using/subscriptions.md
  - Products:
    - products.md
    - RTC:
      - guides/rtc_product_guide.md
      - Product Guide: guides/rtc_product_guide.md
      - StoryMap: https://storymaps.arcgis.com/stories/2ead3222d2294d1fae1d11d3f98d7c35" target="_blank
      - Theoretical Basis: guides/rtc_atbd.md
    - InSAR:
      - guides/insar_product_guide.md
      - Product Guide: guides/insar_product_guide.md
      - StoryMap: https://storymaps.arcgis.com/stories/68a8a3253900411185ae9eb6bb5283d3" target="_blank
    - Burst InSAR:
      - guides/burst_insar_product_guide.md
      - Product Guide: guides/burst_insar_product_guide.md
      - StoryMap: https://storymaps.arcgis.com/stories/191bf1b6962c402086807390b3ce63b0" target="_blank
    - AutoRIFT: https://its-live.jpl.nasa.gov/" target="_blank
    - Usage Guidelines: usage_guidelines.md
    - Sentinel-1 Mission: sentinel1.md
  - SAR Basics:
    - guides/introduction_to_sar.md
    - Introduction to SAR: guides/introduction_to_sar.md
    - Digital Elevation Models: dems.md
    - Water Masking: water_masking.md
    - SAR FAQ: https://asf.alaska.edu/information/sar-information/what-is-sar/#sar_faq" target="_blank
  - Tutorials:
    - tutorials.md
    - Using HyP3 Python SDK: https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-sdk/blob/main/docs/sdk_example.ipynb" target="_blank
    - Search another user's jobs: https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-sdk/blob/main/docs/search_other_user_jobs.ipynb" target="_blank
    - Process new granules for search parameters: tutorials/process-new-granules-for-search-parameters.md
    - InSAR time series with MintPy: https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-docs/blob/main/docs/tutorials/hyp3_insar_stack_for_ts_analysis.ipynb" target="_blank
    - InSAR burst time series with MintPy: https://github.com/ASFHyP3/hyp3-docs/blob/main/docs/tutorials/hyp3_isce2_burst_stack_for_ts_analysis.ipynb" target="_blank
    - Merging burst InSAR products: https://github.com/ASFHyP3/hyp3-docs/blob/develop/docs/tutorials/hyp3_isce2_burst_merge.ipynb" target="_blank
    - StoryMap Tutorials: https://asf-daac.maps.arcgis.com/home/index.html" target="_blank
  - Other Tools:
    - ArcGIS Toolbox: tools/arcgis_toolbox.md
    - ASF Tools for Python:
      - tools/asf_tools.md
      - API Reference: tools/asf_tools_api.md
  - Developers:
    - Architecture: how_it_works.md
    - Plugins: plugins.md
    - Contributing: contributing.md
    - Code of Conduct: CODE_OF_CONDUCT.md
  - What's New: whats_new.md
  - Contact Us: contact.md

plugins:
  - search
  - section-index
  - macros:
      module_name: macros
  - mkdocstrings:
      handlers:
          python:
            inherited_members: true
            rendering:
              show_root_toc_entry: false
  - redirects:
      redirect_maps:
        # full link to our hosted docs needed b/c mkdocs-redirects doesn't support hash fragments
        #    See: https://github.com/datarobot/mkdocs-redirects/issues/16
        getting_started.md: 'https://hyp3-docs.asf.alaska.edu/#getting-started'
        tutorials/mintpy.md: 'https://nbviewer.jupyter.org/github/ASFHyP3/hyp3-docs/blob/main/docs/tutorials/hyp3_insar_stack_for_ts_analysis.ipynb'
        using/quota.md: 'using/credits.md'