IsolationKernel · xhan97 · Aug 16, 2026 · Aug 16, 2026
diff --git a/.github/workflows/deploy-gh-pages.yml b/.github/workflows/deploy-gh-pages.yml
@@ -29,6 +29,10 @@ jobs:
       cancel-in-progress: false
     permissions:
       contents: write
+    env:
+      # See docs.yml: silences the properdocs notice pulled in by the nav and
+      # page generation plugins.
+      DISABLE_MKDOCS_2_WARNING: "true"
 
     steps:
       - uses: actions/checkout@v7

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -10,6 +10,11 @@ permissions:
 jobs:
   docs:
     runs-on: ubuntu-latest
+    env:
+      # mkdocs-gen-files, literate-nav, section-index and redirects all depend on
+      # properdocs, which prints a notice about a possible MkDocs 2.0 on every
+      # build. Nothing here is acted on by it, so keep it out of the log.
+      DISABLE_MKDOCS_2_WARNING: "true"
     steps:
       - uses: actions/checkout@v7
         with:

diff --git a/docs/README.md b/docs/README.md
@@ -1,3 +1,8 @@
+---
+description: >-
+  IKPyKit is a scikit-learn compatible Python library implementing Isolation Kernel methods for anomaly detection, clustering and change detection.
+---
+
 <!-- <script src="https://kit.fontawesome.com/d20edc211b.js" crossorigin="anonymous"></script>
 
 <div style="margin-bottom: 10px;">
@@ -99,8 +104,8 @@ clf.predict([[0.1, 0.3], [0, 0.7], [90, 85]])
 
 | Abbr                                                                                           | Algorithm                     | Application                                   | Publication          |
 | ---------------------------------------------------------------------------------------------- | ----------------------------- | --------------------------------------------- | -------------------- |
-| [IsoKernel](./api/kernel/isolation_kernel.md)        | Isolation Kernel              | IK feature mapping and similarity calculating | AAAI2019, SIGKDD2018 |
-| [IsoDisKernel](./api/kernel/isolation_dis_kernel.md) | Isolation Distribution Kernel | Distribution similarity calculating           | SIGKDD2020           |
+| [IsoKernel](./api/kernel/isokernel.md)        | Isolation Kernel              | IK feature mapping and similarity calculating | AAAI2019, SIGKDD2018 |
+| [IsoDisKernel](./api/kernel/isodiskernel.md) | Isolation Distribution Kernel | Distribution similarity calculating           | SIGKDD2020           |
 
 **(ii) Point Anomaly detection** :
 
@@ -123,7 +128,7 @@ clf.predict([[0.1, 0.3], [0, 0.7], [90, 85]])
 | Abbr                                                                                      | Algorithm                                                              | Application                                   | Publication |
 | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | --------------------------------------------- | ----------- |
 | [IKGOD](./api/graph/ikgod.md)                   | Subgraph Centralization: A Necessary Step for Graph Anomaly Detection. | Graph Anomaly Detection                       | SIAM2023    |
-| [IsoGraphKernel](./api/graph/IsoGraphKernel.md) | Isolation Graph Kernel                                                 | Graph IK embedding and similarity calculating | AAAI2021    |
+| [IsoGraphKernel](./api/graph/isographkernel.md) | Isolation Graph Kernel                                                 | Graph IK embedding and similarity calculating | AAAI2021    |
 
 **(V) Group Data** :
 
@@ -135,7 +140,7 @@ clf.predict([[0.1, 0.3], [0, 0.7], [90, 85]])
 
 | Abbr                                                                           | Algorithm                                                       | Application                    | Publication |
 | ------------------------------------------------------------------------------ | --------------------------------------------------------------- | ------------------------------ | ----------- |
-| [StreaKHC](./api/stream/streakhc.md) | Isolation Distribution Kernel for Trajectory Anomaly Detections | Online Hierarchical Clustering | SIGKDD2022  |
+| [StreaKHC](./api/stream/streamkhc.md) | Isolation Distribution Kernel for Trajectory Anomaly Detections | Online Hierarchical Clustering | SIGKDD2022  |
 | [ICID](./api/stream/icid.md)         | Detecting change intervals with isolation distributional kernel | Change Intervals Detection     | JAIR2024    |
 
 **(VII) Trajectory Data** :
@@ -149,7 +154,7 @@ clf.predict([[0.1, 0.3], [0, 0.7], [90, 85]])
 
 | Abbr                                                                          | Algorithm                                                       | Application       | Publication |
 | ----------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------------- | ----------- |
-| [IKTOD](./api/time_series/iktod.md) | Isolation distribution kernel for Time Series Anomaly Detection | Anomaly detection | VLDB2022    |
+| [IKTOD](./api/timeseries/iktod.md) | Isolation distribution kernel for Time Series Anomaly Detection | Anomaly detection | VLDB2022    |
 
 ---
 

diff --git a/docs/api/anomaly/idkd.md b/docs/api/anomaly/idkd.md
diff --git a/docs/api/anomaly/iforest.md b/docs/api/anomaly/iforest.md
diff --git a/docs/api/anomaly/inne.md b/docs/api/anomaly/inne.md
diff --git a/docs/api/cluster/idkc.md b/docs/api/cluster/idkc.md
diff --git a/docs/api/cluster/ikahc.md b/docs/api/cluster/ikahc.md
diff --git a/docs/api/cluster/pskc.md b/docs/api/cluster/pskc.md
diff --git a/docs/api/graph/IsoGraphKernel.md b/docs/api/graph/IsoGraphKernel.md
diff --git a/docs/api/graph/ikgod.md b/docs/api/graph/ikgod.md
diff --git a/docs/api/group/ikgad.md b/docs/api/group/ikgad.md
diff --git a/docs/api/kernel/isolation_dis_kernel.md b/docs/api/kernel/isolation_dis_kernel.md
diff --git a/docs/api/kernel/isolation_kernel.md b/docs/api/kernel/isolation_kernel.md
diff --git a/docs/api/stream/icid.md b/docs/api/stream/icid.md
diff --git a/docs/api/stream/streakhc.md b/docs/api/stream/streakhc.md
diff --git a/docs/api/time_series/iktod.md b/docs/api/time_series/iktod.md
diff --git a/docs/api/trajectory/data_loader/sheep_dogs.md b/docs/api/trajectory/data_loader/sheep_dogs.md
diff --git a/docs/api/trajectory/ikat.md b/docs/api/trajectory/ikat.md
diff --git a/docs/api/trajectory/tidkc.md b/docs/api/trajectory/tidkc.md
diff --git a/docs/authors/authors.md b/docs/authors/authors.md
@@ -1,3 +1,8 @@
+---
+description: >-
+  The authors and contributors behind IKPyKit, and how to get involved.
+---
+
 # Authors
 
 All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.

diff --git a/docs/contributing/contribution.md b/docs/contributing/contribution.md
@@ -1,3 +1,8 @@
+---
+description: >-
+  How to contribute to IKPyKit: setting up a development environment, running the tests and opening a pull request.
+---
+
 Contributing to ikpykit
 =====================
 

diff --git a/docs/examples/examples_english.md b/docs/examples/examples_english.md
@@ -1,3 +1,8 @@
+---
+description: >-
+  Worked examples and tutorials showing how to apply the Isolation Kernel estimators in IKPyKit to real data.
+---
+
 <script src="https://kit.fontawesome.com/d20edc211b.js" crossorigin="anonymous"></script>
 
 # Examples and Tutorials

diff --git a/docs/faq/table-of-contents.md b/docs/faq/table-of-contents.md
@@ -1,3 +1,8 @@
+---
+description: >-
+  Answers to common questions about installing IKPyKit, the Python versions it supports and how its models behave.
+---
+
 # Frequently Asked Questions
 
 This page collects common questions about IKPyKit usage, installation, and model behavior.

diff --git a/docs/quick-start/how-to-install.md b/docs/quick-start/how-to-install.md
@@ -1,3 +1,8 @@
+---
+description: >-
+  How to install IKPyKit with uv or pip, including the optional dependencies needed for the extended features.
+---
+
 # Installation Guide
 
 This guide will help you install `ikpykit`. The default installation of `ikpykit` includes only the essential dependencies required for basic functionality. Additional optional dependencies can be installed for extended features.

diff --git a/docs/releases/releases.md b/docs/releases/releases.md
@@ -1,3 +1,8 @@
+---
+description: >-
+  Changelog for IKPyKit: the features, enhancements, API changes and fixes in every release.
+---
+
 # Changelog
 
 All significant changes to this project are documented in this release file.

diff --git a/docs/user_guides/table-of-contents.md b/docs/user_guides/table-of-contents.md
@@ -1,3 +1,8 @@
+---
+description: >-
+  User guides for IKPyKit, organised by task: anomaly detection, clustering, change detection and kernel similarity.
+---
+
 # Table of Contents
 
 Welcome to the ikpykit user guides! This comprehensive collection of guides is designed to help you navigate through the various features and functionalities of ikpykit. Whether you are a beginner or an advanced user, you will find the necessary resources to master data with ikpykit. Below, you will find the user guides categorized by topic for easier navigation.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -31,33 +31,10 @@ nav:
   - Examples and tutorials:
       - Examples: examples/examples_english.md
 
-  - API Reference:
-      - Isolation Kernel:
-          - Isolation Kernel: api/kernel/isolation_kernel.md
-          - Isolation Distribution Kernel: api/kernel/isolation_dis_kernel.md
-      - Point Anomaly Detection:
-          - IForest: api/anomaly/iforest.md
-          - INNE: api/anomaly/inne.md
-          - IDKD: api/anomaly/idkd.md
-      - Point Clustering:
-          - IDKC: api/cluster/idkc.md
-          - PSKC: api/cluster/pskc.md
-          - IKAHC: api/cluster/ikahc.md
-      - Graph Mining:
-          - IKGOD: api/graph/ikgod.md
-          - IsoGraphKernel: api/graph/IsoGraphKernel.md
-      - Group Mining:
-          - IKGAD: api/group/ikgad.md
-      - Stream Mining:
-          - ICID: api/stream/icid.md
-          - StreaKHC: api/stream/streakhc.md
-      - Trajectory Mining:
-          - DataLoader:
-              - SheepDogs: api/trajectory/data_loader/sheep_dogs.md
-          - IKAT: api/trajectory/ikat.md
-          - TIDKC: api/trajectory/tidkc.md
-      - Time Series Mining:
-          - IKTOD: api/time_series/iktod.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
 
@@ -70,6 +47,17 @@ nav:
   - 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:
@@ -141,12 +129,27 @@ plugins:
         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.

diff --git a/pyproject.toml b/pyproject.toml
@@ -94,13 +94,17 @@ docs = [
     "matplotlib>=3.9.0",
     "mike==2.2.0",
     "mkdocs==1.6.1",
+    "mkdocs-gen-files==0.6.1",
     "mkdocs-git-revision-date-localized-plugin==1.5.3",
     "mkdocs-jupyter==0.26.3",
+    "mkdocs-literate-nav==0.6.3",
     "mkdocs-llmstxt==0.5.0",
     # The theme was previously only reached through mkdocs-jupyter. It is a
     # direct requirement of this site, and the imaging extra (cairosvg, pillow)
     # is what the built-in social plugin renders cards with.
     "mkdocs-material[imaging]==9.7.7",
+    "mkdocs-redirects==1.2.3",
+    "mkdocs-section-index==0.3.12",
     "mkdocstrings==1.0.6",
     "mkdocstrings-python==2.0.5",
     "notebook==7.6.2",