mkdocs.yml

---
site_name: matfree documentation
repo_url: https://github.com/pnkraemer/matfree
repo_name: pnkraemer/matfree
theme:
  name: material
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: white
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: '(prefers-color-scheme: light)'
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Fira Sans
  features: [navigation.sections, navigation.footer]
plugins:
  - search
  - mkdocs-jupyter:
      include: ['*.py']
      execute: true
      allow_errors: false
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: true
            show_root_toc_entry: true
            show_root_full_path: true
            show_root_members_full_path: true
            show_object_full_path: true
            show_category_heading: false
            docstring_style: numpy
            docstring_section_style: table
            show_if_no_docstring: true
            members_order: alphabetical
            annotations_path: brief
            show_signature: true
            show_signature_annotations: true
            separate_signature: false
            show_source: true
watch: [matfree]
extra:
  social:
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/@pnkraemer
      name: pnkraemer on X
    - icon: fontawesome/brands/github
      link: https://github.com/pnkraemer
      name: pnkraemer on GitHub
  generator: false
copyright: Copyright © 2023 Nicholas Krämer
markdown_extensions:
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - pymdownx.details
extra_javascript:
  # From: https://squidfunk.github.io/mkdocs-material/reference/mathjax/#mkdocsyml
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js