SubDomain/mkdocs.yml at main · HiDiHlabs/SubDomain · 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
site_name: SubDomain
site_url: https://HiDiHlabs.github.io/SubDomain/
repo_url: https://github.com/HiDiHlabs/SubDomain/
repo_name: HiDiHlabs/SubDomain
edit_uri: edit/main/docs/
copyright: Copyright 2025 HiDiHlabs

nav:
  - Home: index.md
  - install.md
  - tutorial.ipynb
  - reference.md

theme:
  name: material
  features:
    - content.code.copy
    # - navigation.tabs
    - navigation.tracking
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default

      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  icon:
    # repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

extra:
  version:
    default: stable
    provider: mike
    alias: true

plugins:
  - search
  - mkdocs-jupyter
  - mkdocstrings:
      default_handler: python
      enable_inventory: true
      handlers:
        python:
          options:
            docstring_style: numpy
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://docs.jax.dev/en/latest/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
            - https://scikit-learn.org/stable/objects.inv
            - https://docs.rapids.ai/api/cuml/stable/objects.inv
            - https://seaborn.pydata.org/objects.inv