pypsa-eur/mkdocs.yml at master · PyPSA/pypsa-eur · 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
143
# SPDX-FileCopyrightText: Contributors to PyPSA-Eur <https://github.com/pypsa/pypsa-eur>
#
# SPDX-License-Identifier: CC-BY-4.0

site_name: PyPSA-Eur
site_url: https://pypsa-eur.readthedocs.io
repo_url: https://github.com/pypsa/pypsa-eur
repo_name: pypsa/pypsa-eur

docs_dir: doc

theme:
  name: material
  logo: img/logo.svg
  features:
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.sections
  - navigation.expand
  - navigation.indexes
  - navigation.top
  - navigation.tracking
  - search.suggest
  - content.code.copy
  - content.tabs.link
  - content.action.edit
  - content.action.view
  - toc.follow
  - search.highlight
  - search.share
  font:
    text: Overpass

nav:
- Home:
  - Home: index.md
  - Getting Started:
    - Introduction: introduction.md
    - Installation: installation.md
    - "Tutorial: Electricity-Only": tutorial.md
    - "Tutorial: Sector-Coupled": tutorial_sector.md
  - References:
    - Release Notes: release_notes.md
    - Licenses: licenses.md
    - Validation: validation.md
    - Limitations: limitations.md
    - Support: support.md
    - Publications: publications.md

- Design:
  - Spatial Resolution: spatial_resolution.md
  - Supply and Demand: supply_demand.md
  - Foresight Options: foresight.md
  - Techno-Economic Assumptions: costs.md
  - OETC Integration: oetc.md

- Configuration:
  - Wildcards: wildcards.md
  - Configuration: configuration.md

- Data Sources:
  - Data Sources: data_sources.md
  - Base Network: data-base-network.md
  - Cutouts: data-cutouts.md
  - Data Repositories: data-repos.md

- Rules Overview:
  - Retrieving Data: retrieve.md
  - Building Electricity Networks: preparation.md
  - Building Sector-Coupled Networks: sector.md
  - Solving Networks: solving.md
  - Plotting and Summaries: plotting.md

- Contributing:
  - contributing.md
  - Validation Development: validation_dev.md


plugins:
- search
- autorefs
- macros:
    module_name: doc/macros
    j2_comment_start_string: "{%#"
    j2_comment_end_string: "#%}"
- table-reader
- mkdocstrings:
    default_handler: python
    enable_inventory: true
    handlers:
      python:
        paths: [scripts, .]
        options:
          docstring_style: numpy
          show_source: false
          show_root_heading: false
          show_root_full_path: false
          show_root_toc_entry: false
          members: false
          allow_inspection: true
        inventories:
        - https://docs.python.org/3/objects.inv
- bibtex:
    bib_file: doc/publications.bib
    enable_inline_citations: false

markdown_extensions:
- footnotes
- admonition
- pymdownx.details
- pymdownx.caret
- pymdownx.tilde
- abbr
- pymdownx.snippets:
    base_path: .
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.arithmatex:
    generic: true
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.highlight
- pymdownx.inlinehilite
- tables
- attr_list
- md_in_html
- toc:
    permalink: true

hooks:
- doc/hooks.py

extra_css:
- assets/stylesheets/extra.css

extra_javascript:
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

copyright: >-
  &copy Copyright PyPSA-Eur Contributors | CC-BY-4.0