-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
90 lines (82 loc) · 2.28 KB
/
mkdocs.yml
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
# SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
#
# SPDX-License-Identifier: CC0-1.0
# Project
site_name: Open Energy Metadata
site_url:
site_description: Open Energy Metadata (OEMetadata) is an energy metadata standard including a template, examples and a metadata schema.
# Repository
repo_name: OpenEnergyPlatform/oemetadata
repo_url: https://github.com/OpenEnergyPlatform/oemetadata
docs_dir: docs
# Configuration
theme:
name: material
logo: img/OpenEnergyFamily_Logo_OEMetadata_white.png
palette:
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
icon:
repo: fontawesome/brands/github
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.indexes
- navigation.path
- navigation.tracking
- navigation.top
- toc.follow
# extensions
markdown_extensions:
- admonition
- toc:
permalink: "#"
plugins:
- mkdocstrings:
# Customization
extra:
generator: false
homepage: https://openenergyplatform.org/
extra_css:
- css/extra.css
# Navigation
nav:
- Home: index.md
- Development:
- Collaboration:
- development/collaboration/index.md
- License: development/collaboration/license.md
- Citation: development/collaboration/citation.md
- Contributing: development/collaboration/contributing.md
- Users: development/collaboration/users.md
- Code of Conduct: development/collaboration/code_of_conduct.md
- Git:
- development/git/index.md
- Gitignore: development/git/gitignore.md
- Documentation:
- development/documentation/index.md
- Release:
- development/release/index.md
- Metadata Documentation:
- metadata/index.md
- Key Description: metadata/metadata_key_description.md
- Metadata Mappings: metadata/metadata_mappings.md
- Code Documentation:
- Install:
- code/install/index.md
- Tests:
- code/test/index.md
# - Code Style:
# - code/style/index.md
# - Functions:
# - code/index.md
# - code/code_example.md