mkdocs.yml

# Project information
site_name: A-Profiles
site_author: Augustin Mortier
site_description: Documentation for A-Profiles
copyright: '2024, Augustin Mortier'
site_url: 'https://github.com/AugustinMortier/A-Profiles'

# Theme configuration
theme:
  name: material
  logo: assets/images/a-profiles.svg
  features:
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.sections
    - navigation.footer
    - content.code.copy
    - content.code.select
    - content.code.annotate

  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  highlightjs: true

  # Custom CSS and JS (equivalent of 'html_css_files' and 'html_js_files')
  extra_css:
    - css/custom.css
  extra_javascript:
    - js/custom.js

# To set logos for different color schemes, use:
extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/gitlab
      link: https://vprofiles.met.no
      name: V-Profiles

# Repository information (replaces the 'icon_links' feature in Sphinx)
repo_name: 'AugustinMortier/A-Profiles'
repo_url: 'https://github.com/AugustinMortier/A-Profiles'
edit_uri: ''

# Navigation and Sidebar
nav:
  - Home: index.md
  - Installation: installation.md
  - Examples: examples.md
  - API:
      - Overview: api.md
      - Reading: api/reading.md
      - Data Classes: api/data_classes.md
      - Detection: api/detection.md
      - Retrieval: api/retrieval.md
      - Simulation: api/simulation.md
      - Plotting: api/plotting.md
      - Writing: api/writing.md
  - CLI: cli.md
  - Changelog: changelog.md

# Plugins
plugins:
  - search
  - autorefs
  - mkdocstrings:
      default_handler: python

# Markdown extensions
markdown_extensions:
  - markdown_include.include:
      base_path: docs/
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: True
      toc_depth: 2
  - footnotes
  - abbr
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.highlight
  - pymdownx.snippets
  - md_in_html
  - pymdownx.arithmatex:
      generic: true

# Static resources
extra_css:
  - assets/css/custom.css
  - https://unpkg.com/katex@0/dist/katex.min.css
extra_javascript:
  - assets/js/custom.js
  - assets/js/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
#extra_files:
#  - aprofiles/cli/aprocess.py
#  - aprofiles/cli/utils/workflow.py