Credit-Risk-Modelling/mkdocs.yml at master · RandomCollection/Credit-Risk-Modelling · 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
site_name: Credit Risk Modelling
site_description: Credit Risk Modelling is a Python library providing a curated selection of modules to perform credit risk modelling analytics.
site_author: RandomCollection
site_url: https://github.com/RandomCollection
repo_name: GitHub
repo_url: https://github.com/RandomCollection/Credit-Risk-Modelling
copyright: Copyright &copy; 2024 RandomCollection

theme:
  features:
    - tabs
  name: material
  favicon: img/icon.svg
  icon:
    logo: material/cactus  # icons are in "...\site-packages\material\templates\.icons\fontawesome\brands"
  palette:
    primary: indigo
    accent: deep purple
  font:
    text: Ubuntu
    code: Ubuntu Mono

plugins:
- search
- markdown-exec
- mkdocstrings:
    handlers:
      python:
        options:
          show_source: false  # removes the source code

nav:
  - Home: index.md
  - Instructions: instructions.md
  - Credit Risk Modelling:
    - Calibration: calibration.md
    - Discrimination: discrimination.md
    - Formatting: formatting.md
    - Frequency: frequency.md
    - Migration: migration.md
    - Override: override.md
    - Plotting: plotting.md
    - Stability: stability.md
    - Other: other.md

markdown_extensions:
  - md_in_html
  - pymdownx.arithmatex
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/RandomCollection