bitepy/mkdocs.yml at main · DimitriBez/bitepy · 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
site_name: "BitePy - A Python Battery Intraday Trading Engine"
site_url: "https://dschaurecker.github.io/bitepy/"

site_description: "Documentation for BitePy: a Python high-frequency intraday trading engine for simulating battery strategies on the European market using dynamic programming."

nav:
  - Home: index.md
  - Data Preprocessing: data.md
  - Simulation: simulation.md
  - Results Postprocessing: results.md
  - About: about.md
  - Issues [Github] : "https://github.com/dschaurecker/bitepy/issues"
  - Source [Github] : "https://github.com/dschaurecker/bitepy/tree/main"
  - Licence [Github] : "https://github.com/dschaurecker/bitepy/blob/main/LICENSE"

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      accent: deep orange
      primary: green
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      accent: deep orange
      primary: teal
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  logo: "assets/bite_logo.png"
  favicon: "assets/bite_logo.png"

extra:
  analytics:
    provider: google
    property: G-20FJGP4HBS

plugins:
  - search
  - mkdocstrings
  - exclude:
      glob:
        - "bitepy/cpp-source-submodule/*"
        - "bitepy/_bite.cpp"