optipfair/mkdocs.yml at main · peremartra/optipfair · 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
site_name: OptiPFair
site_description: A library for structured pruning & Biasd visualization of large language models
site_author: Pere Martra
site_url: https://peremartra.github.io/optipfair/

repo_name: peremartra/optipfair
repo_url: https://github.com/peremartra/optipfair
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    primary: indigo
    accent: indigo
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy

nav:
  - Home: index.md
  - Getting Started:
    - Installation: installation.md
    - Usage: usage.md
  - Knowledge Distillation: knowledge_distillation.md
  - Examples: examples.md
  - Bias Visualization: bias_visualization.md
  - API Reference: api.md
  - Contributing: contributing.md
  - Roadmap: roadmap.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [optipfair]
          options:
            docstring_style: google
            show_source: true
            show_category_heading: true
            show_submodules: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/peremartra
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/optipfair/

copyright: Copyright &copy; 2025 OptiPFair Contributors