mkdocs.yml

site_name: IKPyKit Docs
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/page-actions.js
repo_url: https://github.com/IsolationKernel/ikpykit
site_url: https://isolationkernel.github.io/ikpykit
remote_branch: docs_dev
site_description: Python library for Isolation Kernel Toolkit.
site_author: Isolation Kernel Team
use_directory_urls: false
# custom_dir below points inside docs/, so mkdocs would otherwise also copy
# the theme template into the site as a page, serving raw Jinja at
# /overrides/main.html.
exclude_docs: |
  overrides/
copyright: Copyright © 2024 - 2026 Xin Han

nav:
  - Home:
      - Welcome to IKPyKit: README.md

  - Quick start:
      - How to install: quick-start/how-to-install.md

  - User Guides:
      - Table of contents: user_guides/table-of-contents.md
      - Anomaly detection:
          - INNE: user_guides/inne.ipynb

  - Examples and tutorials:
      - Examples: examples/examples_english.md

  # Pages and sub-navigation are generated from the package by
  # scripts/gen_api_pages.py; literate-nav expands this entry from the
  # api/SUMMARY.md that script writes.
  - API Reference: api/

  - Releases: releases/releases.md

  - FAQ:
      - Table of contents: faq/table-of-contents.md

  - Contributing:
      - How to contribute: contributing/contribution.md

  - Authors: authors/authors.md

plugins:
  # First, so the pages it writes are in the file collection before any plugin
  # that looks at it: literate-nav needs api/SUMMARY.md, and the llmstxt
  # sections below resolve their globs against that collection too.
  - gen-files:
      scripts:
        - scripts/gen_api_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  # Lets the generated api/index.md serve as the "API Reference" section itself,
  # so the tab links to the overview instead of doing nothing.
  - section-index
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://mkdocstrings.github.io/autorefs/objects.inv
            - https://www.mkdocs.org/objects.inv
            - https://python-markdown.github.io/objects.inv
          options:
            docstring_style: numpy
            docstring_section_style: table
            show_root_heading: true
            show_root_full_path: true
            merge_init_into_class: true
            show_symbol_type_heading: false
            separate_signature: true
            show_signature_annotations: false
            summary: true
            filters: ["!^_", "^__init__$", "!^_[^_]"] # exclude all members starting with __
            members_order: source
            docstring_options:
              ignore_init_summary: true
  - mkdocs-jupyter:
      ignore_h1_titles: True
      include_source: True
      execute: True
      allow_errors: False
      include_requirejs: True
  - search:
  # Both docs workflows check out with fetch-depth: 0, so the full history the
  # plugin needs to date a page is available.
  - git-revision-date-localized:
      type: date
      enable_creation_date: true
      # Pages the plugin cannot date (anything untracked at build time) fall
      # back to the build date instead of failing the strict build.
      fallback_to_build_date: true
  - mike:
      alias_type: redirect
      redirect_template: null
      deploy_prefix: ""
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js
  # Renders a preview card per page for link unfurling in chat apps and social
  # networks. Card URLs are absolute, built from site_url, which mike rewrites
  # to include the version prefix during a versioned deploy.
  - social:
      cards_layout_options:
        background_color: "#3499cd" # matches the primary and the logo
  # Must come after mkdocstrings and mkdocs-jupyter: this plugin converts the
  # rendered HTML back to Markdown, so it needs their output to already exist.
  # Otherwise the API pages would export as bare `::: ikpykit.X` directives.
  - llmstxt:
      markdown_description: >-
        IKPyKit implements Isolation Kernel methods for anomaly detection,
        clustering, and representation learning, over points, graphs, groups,
        streams, trajectories, and time series. The estimators follow the
        scikit-learn API.
      full_output: llms-full.txt
      sections:
        Getting started:
          - README.md
          - quick-start/how-to-install.md
        User guides:
          - user_guides/*.md
          - user_guides/inne.ipynb
        Examples:
          - examples/*.md
        API reference:
          # The overview needs listing on its own: the glob below only matches
          # pages that sit in a subdirectory of api/.
          - api/index.md
          - api/**/*.md
        Project:
          - releases/releases.md
          - faq/table-of-contents.md
          - contributing/contribution.md
          - authors/authors.md
  # Six API pages were hand-named and no longer match what the generator derives
  # from the class. This keeps links published against v0.3.0 and earlier
  # working. It is a fixed list of legacy paths, not something a new estimator
  # ever needs to be added to.
  - redirects:
      redirect_maps:
        api/kernel/isolation_kernel.md: api/kernel/isokernel.md
        api/kernel/isolation_dis_kernel.md: api/kernel/isodiskernel.md
        api/graph/IsoGraphKernel.md: api/graph/isographkernel.md
        api/stream/streakhc.md: api/stream/streamkhc.md
        api/time_series/iktod.md: api/timeseries/iktod.md
        api/trajectory/data_loader/sheep_dogs.md: api/trajectory/dataloader/sheepdogs.md
  # Downloads the external assets the pages reference (Google Fonts, the CDN
  # copy of require.js that mkdocs-jupyter pulls in) and serves them from this
  # site instead, so a visitor's browser makes no third-party requests for them.
  # Listed last because it rewrites the built output.
  - privacy:
      assets_exclude:
        # Google Analytics has to load from Google to work at all, so
        # self-hosting it would only break the tag. The cookie consent banner
        # in `extra.consent` stays for that reason.
        - www.googletagmanager.com/*
        # The README badges are rendered on request by their providers. A local
        # copy would freeze the download counts, coverage and build status at
        # the moment the docs were built.
        - img.shields.io/*
        - static.pepy.tech/*
        - codecov.io/*
        - www.repostatus.org/*
        - github.com/*/badge.svg
        # The theme bundle names this URL so it can lazy-load Mermaid for
        # diagrams. This site defines none, so vendoring it would add 3.4 MB to
        # every deployed version for a file no page ever requests.
        - unpkg.com/mermaid*
        # A Font Awesome kit is a loader, not the icons: the config it carries
        # points at ka-f.fontawesome.com, so a local copy still reaches out to
        # Font Awesome and only adds a way for the kit to break.
        - kit.fontawesome.com/*
theme:
  name: material
  custom_dir: docs/overrides
  favicon: img/logo.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.path
    #- navigation.sections # To expand sections on the table of contents
    #- navigation.expand # To expand sections on the table of contents
    - navigation.top
    - toc.integrate
    - navigation.breadcrumbs
    - content.code.annotate
    - content.code.copy
    - content.tooltips
  font:
    text: Open Sans
    code: Ubuntu Mono
  highlightjs: true
  logo: img/logo.svg
  palette:
    - scheme: default
      # "custom" defers to the values in stylesheets/extra.css, which carry
      # scikit-learn's exact blue and orange -- the same pair the logo uses.
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - codehilite
  - footnotes
  - pymdownx.details
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: true
      linenums: false
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.magiclink

extra:
  version:
    provider: mike
  analytics:
    provider: google
    property: G-GR8X9Z9LKL
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  seo:
    description: >-
      **IKPyKit** (Isolation Kernel Python toolKit) is an intuitive Python library designed for a variety of machine learning tasks including kernel similarity calculation, anomaly detection, clustering, and change detection—all powered by the innovative **Isolation Kernel (IK)** . Isolation Kernel is a data-dependent kernel that measures similarity by isolating data points using an isolation mechanism. It uniquely adapts to the data distribution, with the property that points in sparse regions are more similar than those in dense regions. Notably, it requires no learning or closed-form expression, making it efficient and scalable.
    keywords: time series, forecasting, machine learning, python, data science, scikit-learn, anomaly detection, clustering, change detection, kernel similarity, isolation kernel