jarvais/mkdocs.yml at main · pmcdi/jarvais · 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
site_name: jarvAIs Documentation

theme:
    name: material
    features:
      - navigation.instant
      - navigation.tabs
      - navigation.tabs.sticky
      - navigation.tracking
      - announce.dismiss

    palette:
      # Palette toggle for dark mode
      - scheme: slate
        toggle:
          icon: material/lightbulb
          name: Switch to light mode

      # Palette toggle for light mode
      - scheme: default
        toggle:
          icon: material/lightbulb-outline
          name: Switch to dark mode

repo_url: https://github.com/pmcdi/jarvais
repo_name: GitHub

plugins:
  - search
  - mkdocstrings
  - mkdocs-jupyter:
      execute: False
  - mkdocs-pdf

markdown_extensions:
  - attr_list
  - mkdocs-click

nav:
  - Introduction: index.md
  - Get Started:
    - Analyzer Quick Start: get_started/analyzer.md
    - Trainer Quick Start: get_started/trainer.md
    - Explainer Quick Start: get_started/explainer.md
  - Tutorials:
      - tutorials/index.md
      - Classification: tutorials/classification.ipynb
      - Regression: tutorials/regression.ipynb
      - Survival: tutorials/survival.ipynb
  - API:
      - Analyzer: api/analyzer.md
      - Trainer: api/trainer.md
      - Explainer: api/explainer.md
      - Utils:
        - Plotting: api/plot.md
        - Functional: api/functional.md
        - PDF: api/pdf.md
  - CLI: cli/jarvais.md

extra_css:
  - assets/styles.css