mkdocs.yml

---
# Project Information
site_name: "OMEGA-Py"
site_url: "https://astcherbinine.github.io/omegapy"
site_author: "Aurélien Stcherbinine"
site_description: "OMEGA-Py: Python tools for OMEGA data"

# Repository information
repo_name: "AStcherbinine/omegapy"
repo_url: "https://github.com/AStcherbinine/omegapy"
edit_uri: "edit/main/docs/"

# Copyright
copyright: Copyright © 2024 Aurélien Stcherbinine

# Configuration
theme:
  name: material
  icon:
    repo: fontawesome/brands/github
    view: material/eye
  logo: img/logo_omegapy.svg
  favicon: img/favicon_omegapy.ico
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Dark mode
      primary: red
      accent: orange
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Light mode
      primary: red
      accent: orange
  features:
    - navigation.instant
    #- navigation.tabs
    #- navigation.tabs.sticky
    #- navigation.sections
    #- navigation.path
    #- navigation.expand
    - navigation.indexes
    - toc.integrate
    - toc.follow
    - content.code.copy
    #- content.code.select
    - content.code.annotate
    #- content.tabs.link
  language: en

plugins:
  - search
  - autorefs
  - gen-files:
      scripts:
      - docs/gen_api_pages.py
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [omegapy]
          options:
            docstring_style: numpy
            docstring_section_style: table
            #docstring_section_style: list
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_object_full_path: true
            members_order: alphabetical
            #members_order: source
            #separate_signature: true
  - literate-nav:
      nav_file: SUMMARY.md

markdown_extensions:
  # Code highlighting (with Pygments)
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  #- pymdownx.snippets
  - pymdownx.snippets:
      auto_append:
        - docs/abbreviations.md
  - pymdownx.superfences
  # footnotes
  - footnotes
  # image support
  - attr_list
  - md_in_html
  # lists
  - def_list
  #- pymdownx.tasklist:
    #custom_checkbox: true
  - admonition
  - pymdownx.details
  #- pymdownx.superfences
  # content tabs
  #- pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true 
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.smartsymbols
  # Annotations
  #- attr_list
  #- md_in_html
  #- pymdownx.superfences
  # Emojis
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  # Abbreviations
  - abbr
  #- attr_list
  #- pymdownx.snippets


# Footer
extra:
  #history_buttons: false
  version: v2.4
  #nav_links:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AStcherbinine
      name: AStcherbinine on GitHub
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/Astrorelien
      name: Astrorelien on Twitter
    - icon: fontawesome/brands/researchgate
      link: https://www.researchgate.net/profile/Aurelien-Stcherbinine
      name: Aurélien Stcherbinine on ResearchGate
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/aurelien-stcherbinine/
      name: Aurélien Stcherbinine on LinkedIn
    - icon: fontawesome/solid/globe
      link: https://aurelien.stcherbinine.net/
      name: Aurélien Stcherbinine personal page

# Page tree
nav:
  - Home: index.md
  #- About: about.md
  - Getting started:
    - Installation: installation.md
    - Configuration: configuration.md
    - Basic usage: basic_usage.md
  - User Guide:
    - Data importation: data_importation.md
    - Data correction: data_correction.md
    - Data handling: data_handling.md
    - Data visualization: data_visualization.md
    #- IDL SOFT10 Readme: SOFT10_readme.txt
  - Examples: 
    - Band depth: example1_band_depth.md
    - Overplotting: example2_overplot.md
  - Code Reference: reference/
  - Community guidelines: community.md
  - Litterature: litterature.md
  - Credits: credits.md