mkdocs.yml

site_name: Tsumugi
site_url: "https://mrpowers-io.github.io/tsumugi-spark/"
repo_url: "https://github.com/mrpowers-io/tsumugi-spark"
repo_name: "mrpowers-io/tsumugi-spark"

theme:
  name: material
  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  features:
    - navigation.tracking
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
    - navigation.indexes
    - navigation.expand
    - content.tabs.link
    - content.code.copy
    - content.code.select

plugins:
  - search
  - section-index
  - mkdocs-jupyter
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: sphinx
            docstring_options:
              show_if_no_docstring: true
            show_source: true

nav:
  - Home: index.md
  - About:
    - Concepts: "concepts/concepts.md"
    - Usecases: "concepts/usecases.md"
  - Python API:
    - 'Main data structures': "python/main_structures.md"
    - 'API Reference': "python/reference/SUMMARY.md"
  - Example Notebooks:
    - 'Basic usage': "notebooks/basic_example.ipynb"
    - 'Using predicates': "notebooks/using_where.ipynb"
  - Contributing:
    - 'Dev environment & code style': "dev/contributing.md"

markdown_extensions:
    - markdown_include.include:
        base_path: docs
    - attr_list
    - pymdownx.emoji:
        emoji_index: !!python/name:material.extensions.emoji.twemoji
        emoji_generator: !!python/name:material.extensions.emoji.to_svg
    - pymdownx.highlight:
        anchor_linenums: true
        line_spans: __span
        pygments_lang_class: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences