gridfm-graphkit/mkdocs.yml at main · gridfm/gridfm-graphkit · 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
83
84
site_name: "gridfm-graphkit"
repo_url: https://github.com/gridfm/gridfm-graphkit
site_url: https://gridfm.github.io/gridfm-graphkit/
repo_name: GitHub

nav:
  - Home: index.md
  - Installation: install/installation.md
  - Getting started:
    - CLI commands: quick_start/quick_start.md
    - YAML configuration file: quick_start/yaml_config.md
  - Tutorials:
    - Visualizing predictions of GridFM: tutorials/feature_reconstruction.md
    - Contingency analysis: tutorials/contingency_analysis.md
  - Components:
    - Datasets:
      - Data normalization: datasets/data_normalization.md
      - Power Grid datasets: datasets/powergrid.md
      - Data Modules: datasets/data_modules.md
      - Transforms: datasets/transforms.md
    - Tasks:
      - Feature Reconstruction: tasks/feature_reconstruction.md
    - Models: models/models.md
    - Training:
      - Losses: training/loss.md


theme:
  name: material
  palette:
    primary: white
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.indexes
    - navigation.tracking
    - toc.follow
    - search.suggest
    - navigation.instant
    - navigation.instant.progress
    - content.code.copy
    - content.code.select
  logo: figs/KIT.png
  favicon: figs/KIT.png

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


markdown_extensions:
  - admonition
  - toc:
      permalink: true

  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

  - 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