powerplantmatching/mkdocs.yaml at master · PyPSA/powerplantmatching · 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# SPDX-FileCopyrightText: 2025 Contributors to powerplantmatching <https://github.com/pypsa/powerplantmatching>
#
# SPDX-License-Identifier: MIT

site_name: Documentation
site_url: https://github.com/PyPSA/powerplantmatching
repo_url: https://github.com/PyPSA/powerplantmatching
repo_name: PyPSA/powerplantmatching
edit_uri: edit/master/docs/

nav:
  - Home:
    - Home: index.md
    - Usage:
      - Installation: installation.md
      - Getting Started: getting-started.md
      - Basics: basics.md
      - Custom Config: custom-config.md
    - About:
      - Release Notes: release-notes.md
      - Contributors: contributors.md
      - Citing: citing.md
      - License: license.md
    - Support:
      - FAQ: faq.md
      - Support: support.md
      - Troubleshooting: troubleshooting.md
  - Example:
    - Example: examples/example.ipynb
  - API reference:
    - Core modules: api-core.md
    - Data processing modules: api-data.md
    - Utility modules: api-utils.md

# Theme settings
theme:
  name: material
  font:
    text: Overpass
  features:
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.sections
  - navigation.tracking  # Anchor tracking
  - navigation.indexes  # Section indexes
  - navigation.path
  - navigation.top # Back to top button
  # - navigation.foot
  - header.autohide
  - content.action.edit
  - content.action.view
  - toc.follow
  - search
  - search.suggest
  - search.highlight
  - search.share
  - announce.dismiss
  - content.code.copy
  - content.code.select

plugins:
  - search
  - autolinks
  - table-reader
  - mkdocs-video
  - mkdocs-jupyter
  # Docstring generation
  - mkdocstrings:
      enabled: true
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: numpy
            docstring_section_style: list
            filters:
            - "!logger"
            - "!^_[^_]"
            heading_level: 2
            merge_init_into_class: true
            parameter_headings: false
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            show_if_no_docstring: true
            show_inheritance_diagram: true

markdown_extensions:
  # Callouts/ Admonitions
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true
  # Footnotes
  - footnotes
  # Tabbed content
  - pymdownx.tabbed:
      alternate_style: true  # Abbreviations
  - pymdownx.snippets:
      auto_append:
      - includes/abbreviations.md
  - abbr
  - attr_list
  - md_in_html
  # Emojis
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  # Toctree with permalinks
  - toc:
      title: On this page
      permalink: true
      toc_depth: 3
    # Grids
  - md_in_html
  - pymdownx.caret
  - pymdownx.tilde


extra:
  social:
  - icon: fontawesome/brands/discord
    link: https://discord.com/invite/AnuJBk23FU
  - icon: fontawesome/brands/github
    link: https://github.com/PyPSA/powerplantmatching

  extra:
  homepage: https://pypsa.org

copyright: >-
  &copy Copyright 2015-2025 Powerplantmatching Developers and Contributors