mkdocs.yml

# Copyright (c) 2016-2022 Martin Donath <martin.donath@squidfunk.com>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Project information
site_name: SALAT Documentation
site_url: https://SolarAlma.github.io/SALAT/

# Repository
repo_name: SolarALMA/SALAT
repo_url: https://github.com/SolarAlma/SALAT
edit_uri: ""

# Copyright
copyright: Copyright &copy; 2024 <a href="https://www.mn.uio.no/rocs/english/projects/solaralma/" target="blank">RoCS/SolarALMA</a>

nav:
  - Home: index.md
  - Getting Started: installation.md
  - Routines:
    - IDL: idl.md
    - Python: python.md
  - Citation: citation.md

# Configuration
theme:
  name: material
  palette:
    - scheme: default
      primary: teal
      accent: teal
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.expand
  favicon: images/favicon.png
  logo: images/favicon.png

# markdown_extensions:
#     - toc:
#         permalink: '#'

# Customization
extra:
  social:
    - icon: fontawesome/solid/house
      link: https://www.mn.uio.no/rocs/english/projects/solaralma/
    - icon: fontawesome/brands/github
      link: https://github.com/SolarAlma/SALAT

plugins:
    - search

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - codehilite
  - def_list
  - footnotes
  - meta
  - md_in_html
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.tables
  - markdown.extensions.abbr
  - markdown.extensions.md_in_html
  - markdown.extensions.meta
  - markdown.extensions.toc:
      baselevel: 1
      permalink: true
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.extra
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde