mkdocs.yml

site_name: earthaccess
site_description: Client library for NASA Earthdata APIs
site_url: https://github.com/nsidc/earthaccess

# Fail on broken links
strict: true

theme:
  name: "material"
  logo: earth.png
  favicon: earth.png
  palette:
    - scheme: default
      primary: teal
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    # Allow navigation sections to link to index/overview pages.
    # See: https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
    - navigation.indexes

repo_name: nsidc/earthaccess
repo_url: https://github.com/nsidc/earthaccess
edit_uri: ""

extra_css:
  - css/styles.css

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: no
            merge_init_into_class: yes
            show_submodules: no
          rendering:
            show_root_heading: false
            show_source: false
  - redirects:
      redirect_maps:
        'CODE_OF_CONDUCT.md': 'contributing/code-of-conduct.md'
        'CODE_OF_CONDUCT.md.md': 'contributing/code-of-conduct.md'
  - mkdocs-jupyter:
      execute: True
      ignore:
        - "tutorials/dask.ipynb"
        - "**/.ipynb_checkpoints/*"

nav:
  - "What is earthaccess?": "index.md"
  - "Quick start": "quick-start.md"
  - "Work with us":
      - "contributing/index.md"
      - "Development": "contributing/development.md"
      - "Releasing": "contributing/releasing.md"
      - "Our meet-ups": "contributing/our-meet-ups.md"
      - "Maintainers Guide": "contributing/maintainers-guide.md"
      - "Code of Conduct": "contributing/code-of-conduct.md"
      - "Contributing naming convention": "contributing/naming-convention.md"
  - "Resources": "resources.md"
  - USER GUIDE:
      - "user_guide/index.md"
      - "Authentication": "user_guide/authenticate.md"
      - "Search": "user_guide/search.md"
      - "Access": "user_guide/access.md"
      - "Backwards Compatibility": "user_guide/backwards-compatibility.md"
  - HOW-TO:
      - "Authenticate with Earthdata Login": "howto/authenticate.md"
      - "Search NASA datasets using filters": "howto/search-collections.md"
      - "Search for data using filters": "howto/search-granules.md"
      - "Determine if a dataset is available in the cloud": "howto/storage-location.md"
      - "Access data": "howto/access-data.md"
      - "Using authenticated sessions to access data": "howto/edl.ipynb"
      - "Download data from on-prem location": "howto/onprem.md"
      - "Direct S3 access - Open/stream files in the cloud": "howto/cloud.md"
      - "Search for services": "howto/search-services.md"
  - TUTORIALS:
      - "Accessing remote NASA data with fsspec": "tutorials/file-access.ipynb"
      - "Search and access of restricted datasets": "tutorials/restricted-datasets.ipynb"
      - "Reproducing NASA sea level rise infographic": "tutorials/SSL.ipynb"
      - "Accessing and visualizing EMIT data with a few lines of code": "tutorials/emit-earthaccess.ipynb"
  - USER REFERENCE:
      - API:
          - "Search and Access": "user-reference/api/api.md"
      - Modules:
          - Collections:
              - "Collection Queries": "user-reference/collections/collections-query.md"
              - "Collection Results": "user-reference/collections/collections.md"
              - "Collection Services": "user-reference/collections/collections-services.md"
          - Granules:
              - "Granule Queries": "user-reference/granules/granules-query.md"
              - "Granule Results": "user-reference/granules/granules.md"
          - Store:
              - "Store": "user-reference/store/store.md"
          - Auth:
              - "Auth": "user-reference/auth/auth.md"
      - Glossary:
          - "NASA Glossary": "user-reference/glossary/nasa-glossary.md"
          - "Cloud Computing Terminology": "user-reference/glossary/cloud-glossary.md"

markdown_extensions:
  - admonition
  - callouts
  - pymdownx.details
  - meta
  - toc:
      toc_depth: 2
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

watch:
  - docs
  - earthaccess
  - notebooks