gridfm-datakit/mkdocs.yml at main · gridfm/gridfm-datakit · 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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
site_name: "gridfm-datakit"
repo_url: https://github.com/gridfm/gridfm-datakit
repo_name: GitHub

nav:
  - Home: index.md
  - Installation: installation.md
  - Manual:
      - Getting Started: manual/getting_started.md
      - Network: manual/network.md
      - Load Scenarios: manual/load_scenarios.md
      - Topology Perturbations: manual/topology_perturbations.md
      - Generation Perturbations: manual/generation_perturbations.md
      - Admittance Perturbations: manual/admittance_perturbations.md
      - Outputs: manual/outputs.md
  - Components:
    - Network: components/network.md
    - Perturbations:
      - Load: components/load.md
      - Topology: components/topology.md
      - Generator: components/generator_perturbation.md
      - Admittance: components/admittance_perturbation.md
    - Process:
      - Process Network: components/process_network.md
      - Solvers: components/solvers.md
    - Save: components/save.md
    - Utils:
      - Utils: components/utils.md
      - Stats: components/stats.md
      - Power Balance: components/power_balance.md
      - Param Handler: components/param_handler.md
    - Generate: components/generate.md
    - Validation: components/validation.md
    - CLI: components/cli.md


theme:
  name: material
  palette:
    primary: white
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.indexes
    - navigation.tracking
    - toc.follow   # <-- Add this line
    - toc.follow
    - search.suggest
    - navigation.instant
    - navigation.instant.progress
  logo: figs/KIT_logo.png
  favicon: figs/KIT_logo.png

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            heading_level: 0
            show_root_heading: false


markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - md_in_html


extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - stylesheets/extra.css
  - https://unpkg.com/katex@0/dist/katex.min.css