mkdocs.yml

# Project information
site_url: https://timeseriestographs.com
site_name: ts2g2
site_author: Joze Rozanec
site_description: >-
  Package for time series to graph conversion and time series generation from graphs

# Repository
repo_name: graph-massivizer/ts2g2
repo_url: https://github.com/graph-massivizer/ts2g2

# Configuration
theme:
  name: material
  features:
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - navigation.indexes
    - navigation.tabs
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    # Palette toggle for light
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: light blue
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Palette toggle for dark
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: light blue
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  logo: assets/imgs/logo.png

edit_uri: ""

# Plugins
plugins:
  - search
  - mkdocs-jupyter
  - mkdocstrings:
      handlers:
        python:
          selection:
            filters:
              - "!^_" 
          options:
            show_source: false

# Markdown Extensions
markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji

# Page tree
nav:
  - Home: index.md

  - Documentation:
    - IO: documentation/tsg_io.md
    - Core model: documentation/model.md
    - Turning time series into graphs: documentation/strategy_to_graph.md
    - Graph linking strategies - univariate: documentation/strategy_linking_graph.md
    - Graph linking strategies - multivariate: documentation/strategy_linking_multi_graphs.md
    - Converting graphs to sequences: documentation/strategy_to_time_sequence.md
    - Embeddings: documentation/embeddings.md

  - Posters & Publications: assets/pdfs/KDD-2024-poster-ts2g.pdf

  - Tutorial: 
    - Overview: tutorial/tutorial-ts2g2-overview.ipynb
    - Turning time series into graphs: 
      - Visibility strategy: tutorial/tutorial-ts2g-visibility-strategy.ipynb
      - Ordinal partition strategy: tutorial/tutorial-ts2g-ordinal-partition.ipynb
      - Quantile strategy: tutorial/tutorial-ts2g-quantiles.ipynb
      - Proximity networks strategy: tutorial/tutorial-ts2g-proximity-networks.ipynb
      - Sliding window strategy: tutorial/tutorial-ts2g-sliding-window-strategy.ipynb
      - Timeseries correlation strategy: tutorial/tutorial-ts2g-timeseries-correlation.ipynb
    - Converting graphs into sequences: tutorial/tutorial-g2ts-strategies.ipynb
    - Embeddings: tutorial/tutorial-ts2g2-embeddings.ipynb
    - Compact tutorial: tutorial/tutorial-ts2g2-compact.ipynb