pypsa_validation_processing/mkdocs.yml at main · maxnutz/pypsa_validation_processing · 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
site_name: pypsa-validation-processing
site_description: Processing PyPSA output to IAMC variables for validation workflows
site_url: https://maxnutz.github.io/pypsa_validation_processing/
repo_name: maxnutz/pypsa_validation_processing
repo_url: https://github.com/maxnutz/pypsa_validation_processing

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.instant
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow

nav:
  - Home: index.md
  - API Reference:
      - Package: api/package.md
      - Workflow: api/workflow.md
      - Class Definitions: api/class_definitions.md
      - Statistics Functions: api/statistics_functions.md
      - Utilities: api/utils.md
  - Contributing: contributing.md
  - Additional Information: additional-information.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - pypsa_validation_processing
          options:
            docstring_style: numpy
            members: true
            filters:
              - "!^_"
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_source: false