PAYN/mkdocs.yml at main · SPP2363/PAYN · 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
site_name: "PAYN Documentation"
site_description: "Documentation for the Positivity Is All You Need (PAYN) framework."
site_author: "Florian Boser, Jan C. Spies, Frank Glorius"
site_url: "https://GloriusGroup.github.io/PAYN"

theme:
  name: "material"
  features:
    - navigation.expand
    - content.code.copy
  palette:
    # Light mode
    - scheme: default
      primary: teal
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: teal
      accent: lime
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Usage Guide:
      - Installation: usage/install.md
      - Configuration: usage/config.md
      - Naming Convention: usage/naming_convention.md
  - API Reference:
      - Configuration: reference/payn.configloader.md
      - Logging: reference/payn.logging.md
      - Data Loader: reference/payn.data_loader.md
      - Data Schema: reference/payn.data_schema.md
      - Featurisation: reference/payn.featurisation.md
      - Splitting Strategy: reference/payn.splitting.md
      - Spy Injection: reference/payn.spysplitting.md
      - Augmentation Models: reference/payn.augmentation_models.md
      - Optimization: reference/payn.optimization.md
      - Data Recombination: reference/payn.recombination.md
      - Regression Model: reference/payn.reg_model.md
      - Evaluation: reference/payn.evaluator.md
      - Visualisation: reference/payn.visualisation.md
  - License: license.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          selection:
            docstring_style: google
          rendering:
            show_source: true
            show_root_heading: true

extra:
  python_path: .