aberrant/mkdocs.yml at main · OliverHennhoefer/aberrant · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
site_name: ABERRANT
site_description: Online anomaly detection for streaming data
site_author: ABERRANT contributors
site_url: https://oliverhennhoefer.github.io/aberrant
repo_url: https://github.com/OliverHennhoefer/aberrant
repo_name: OliverHennhoefer/aberrant
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: site
strict: true

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.top
    - search.highlight
    - content.code.copy

nav:
  - Home: index.md
  - Installation: installation.md
  - Quickstart: quickstart.md
  - User Guide:
    - Overview: user_guide/index.md
    - Models: user_guide/models.md
    - Transformers: user_guide/transformers.md
    - Streaming Datasets: user_guide/streaming.md
    - Pipelines: user_guide/pipelines.md
    - Evaluation: user_guide/evaluation.md
    - Best Practices: user_guide/best_practices.md
  - Examples: examples/index.md
  - API Reference:
    - Overview: api/index.md
    - Base: api/base.md
    - Models:
      - Overview: api/models/index.md
      - Core Models: api/models/core.md
      - Isolation Forest: api/models/iforest.md
      - Distance: api/models/distance.md
      - Sketch: api/models/sketch.md
      - Graph: api/models/graph.md
      - Time Series: api/models/timeseries.md
      - SVM: api/models/svm.md
      - Statistical: api/models/stat.md
      - Deep: api/models/deep.md
    - Transform: api/transform.md
    - Drift: api/drift.md
    - Stream Datasets: api/stream.md
  - Contributing: contributing.md
  - Changelog: changelog.md

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - toc:
      permalink: true