fairscope/mkdocs.yml at main · Rajveer-code/fairscope · 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
site_name: fairscope
site_description: Subgroup-stratified, calibration-aware fairness auditing for ML models
repo_url: https://github.com/Rajveer-code/fairscope
repo_name: Rajveer-code/fairscope

theme:
  name: material
  features:
    - navigation.sections
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: false
            show_root_heading: true
            members_order: source

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - CPFE protocol: cpfe.md
  - Healthcare audit: healthcare.md
  - Federated audit: federated.md
  - Lending audit: lending.md
  - API reference: api.md

markdown_extensions:
  - admonition
  - pymdownx.superfences
  - toc:
      permalink: true

# Internal planning docs and the design/issues files must NOT be published to the site.
exclude_docs: |
  internal/
  DESIGN.md
  planned-issues.md