mkdocs.yml

## Project information
site_name: UP42 Python SDK
site_url: https://up42.github.io/up42-py/
site_description: UP42 Python SDK

## Repository
repo_name: up42-py
repo_url: https://github.com/up42/up42-py
edit_uri: ''  #disables edit button

# Copyright
copyright: UP42 2023

## Social Media
extra:
  social:
    - icon: fontawesome/solid/house
      link: https://up42.com
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/up42_
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/up42/
    - icon: fontawesome/brands/github-alt
      link: https://github.com/up42
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/u/up42
    - icon: fontawesome/solid/envelope
      link: mailto:support@up42.com
  analytics:
    provider: google
    property: 'UA-132885718-1'

## Page tree
nav:
    - Home: index.md
    - Getting Started:
      - Installation: installation.md
      - Authentication: authentication.md
      - Search & Order data: search_order.md
      - Satellite Tasking: tasking.md
      - Storage Assets: storage.md
      - Run Analytics Workflow: analytics_workflow.md
    - Advanced:
        - Functionality: structure.md
        - Geometry Handling: geometry_handling.md
        - Visualizations: visualizations.md
        - Webhooks: webhooks.md
        - Example Notebooks:
          - Pleiades Reflectance (Download): examples/data-block-examples/pleiades-download-example.ipynb
          - NEXTMap One - Elevation Data (Streaming) and Viewshed: examples/data-block-examples/nextmapone-viewshed-data-example.ipynb
          - Open Street Map: examples/data-block-examples/osm-example.ipynb
          - Ship Identification: examples/advanced/ship-identification.ipynb
    - Code Reference:
        - up42: reference/up42-reference.md
        - Catalog: reference/catalog-reference.md
        - Tasking: reference/tasking-reference.md
        - Storage: reference/storage-reference.md
        - Order: reference/order-reference.md
        - Asset: reference/asset-reference.md
        - Project: reference/project-reference.md
        - Workflow: reference/workflow-reference.md
        - Job: reference/job-reference.md
        - JobCollection: reference/jobcollection-reference.md
        - JobTask: reference/jobtask-reference.md
        - Webhooks: reference/webhooks-reference.md
    - Changelog & FAQ:
        - Changelog: CHANGELOG.md
        - FAQ & Support: support-faq.md
        - Privacy Policy: 'https://up42.com/legal/privacy'

## Configuration
theme:
  name: material
  custom_dir: docs/theme_override_home/
  # 404 page
  static_templates:
    - 404.html
  # Don't include MkDocs' JavaScript 
  include_search_page: false
  search_index_only: true
  # Default values, taken from mkdocs_theme.yml
  language: en
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.expand
  palette:
    primary: indigo
    accent: purple
  font:
    text: Roboto
    code: Roboto Mono
  icon:  # from .icons path. Add to theme override for custom logo.
    logo: up42-logo  # top left header logo
  favicon: assets/logo-up42.ico #browser tab logo

## Plugins
plugins:
  - search
  - autolinks
  - mkdocs-jupyter:
      include_source: False
      ignore_h1_titles: True
      include: ["examples/data-block-examples/pleiades-download-example.ipynb",
                "examples/data-block-examples/nextmapone-viewshed-data-example.ipynb",
                "examples/data-block-examples/osm-example.ipynb",
                "examples/advanced/ship-identification.ipynb"]
  - macros:
      module_name: docs/macros
  - exclude:
      glob:
        - "*config*.json"
        - "*cfg*.json"
        - ".ipynb_checkpoints"
        - "*examples/project*"
        - "*swagger*"
        - PULL_REQUEST_TEMPLATE.md
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_root_toc_entry: False
            show_root_heading: False
            show_source: True
            show_category_heading: True
            show_bases: False
          selection:
            filters:
              - "!^_"  # exclude all members starting with _
      watch:
        - up42

## Custom theme additions
extra_javascript:
        - 'stylesheets/extra.js'
extra_css:
        - stylesheets/extra.css

## Extensions
markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.md_in_html
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      baselevel: 1
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde