mkdocs.yml

site_name: DAMNIT
site_url: https://rtd.xfel.eu/docs/damnit

theme:
  name: material
  logo: static/AMORE.png
  favicon: static/AMORE.png
  icon:
    repo: fontawesome/brands/github
  palette:
    scheme: slate
    primary: teal
  features:
    - navigation.indexes
    - content.code.copy

watch:
  - damnit

repo_url: https://github.com/European-XFEL/DAMNIT

# Enable syntax highlighting for the material theme:
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.saneheaders
  - pymdownx.emoji
  - pymdownx.magiclink:
      repo_url_shorthand: true
      normalize_issue_symbols: true
      user: European-XFEL
      repo: DAMNIT
  - tables
  - attr_list
  - toc:
      permalink: "¤"

# Navigation menu order
nav:
  - index.md
  - gui.md
  - backend.md
  - api.md
  - internals.md
  - changelog.md
  - contact.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          import:
          - https://docs.python.org/3/objects.inv
          - https://pandas.pydata.org/docs/objects.inv
          options:
            docstring_style: google
            separate_signature: yes
            show_signature_annotations: yes
            merge_init_into_class: yes
            show_submodules: yes
            members_order: source
            show_root_heading: yes
            heading_level: 3
            show_source: no
            inherited_members: yes

extra_css:
  - css/mkdocstrings.css