oeplatform/mkdocs.yml at develop · OpenEnergyPlatform/oeplatform · 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
# Project
site_name: Open Energy Platform Documentation
site_url:
site_description:
  The Open Energy Platform is the Frontend of the Open Energy Family and
  specifically provides a Webapplication which is documented using mkdocs.

# Repository
repo_name: OpenEnergyFamily/oeplatform
repo_url: https://github.com/OpenEnergyPlatform/oeplatform
docs_dir: docs

# Configuration
theme:
  name: material
  logo:
  palette:
    # Palette toggle for dark mode
    - scheme: default
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    # Palette toggle for light mode
    - scheme: slate
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.path
    - navigation.tracking
    - navigation.top
    - toc.follow
    - search.suggest
    - search.share
    - content.tabs.link

# extensions
markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      use_pygments: true
  # support pad width = 2, as formatted with prettier
  - mdx_truly_sane_lists
  - toc:
      permalink: "#"

plugins:
  - search
  - mkdocstrings
  - include-markdown

# Customization
extra:
  generator: false
  version:
    provider: mike

extra_css:
  - css/extra.css

# Navigation
nav:
  - Home: index.md
  - Getting Started:
      - installation/index.md
      - Installation Guide: installation/guides/installation-docker-dev.md
      - Development setup: installation/guides/development-setup.md
      - Manual Installation Guide: installation/guides/installation.md
      - Production deployment (Podman):
          - installation/production-podman/index.md
          - Install: installation/production-podman/install.md
          - Ontop: installation/production-podman/ontop.md
          - Update: installation/production-podman/update.md
          - Maintenance & troubleshooting: installation/production-podman/maintenance.md
  - Development:
      - dev/index.md

      - Best Practices:
          - Software development process:
              - dev/index.md
          - Frontend and UI:
              - Workflow: dev/frontend/workflow.md
              - Design System: dev/frontend/design-system.md
              - Accessibility: dev/frontend/accessibility.md
      - Context:
          - dev/context.md
  - Documentation:
      - oeplatform-code/index.md
      - Architecture:
          - oeplatform-code/architecture/index.md
          - Infrastructure: oeplatform-code/architecture/infrastructure.md
          - Software Project: oeplatform-code/architecture/project-structure.md
          - oeplatform Modules: oeplatform-code/architecture/modules.md
      - Web-API's:
          - oeplatform-code/web-api/index.md
          - OEDB REST-API:
              - oeplatform-code/web-api/oedb-rest-api/index.md
              - oeplatform-code/web-api/oedb-rest-api/resource-data-size.md
            # - Draft open-API schema: oeplatform-code/web-api/oedb-rest-api/swagger-ui.html
          - OEKG API:
              - oeplatform-code/web-api/oekg-api/index.md
      - Edit scenario datasets: oeplatform-code/web-api/oekg-api/scenario-dataset.md
      - Django Apps:
          - oeplatform-code/apps/index.md
          - oeplatform-code/apps/login.md

      - Features:
          - oeplatform-code/features/index.md
          - 🚧 OEP-Datasets:
              - oeplatform-code/features/oep-datasets/datasets.md
              - oeplatform-code/features/oep-datasets/tech-stack.md
          - 🚧🔄 Upload-Wizard:
              - oeplatform-code/features/upload-wizard/tabular-data-upload.md
          - metaBuilder (Metadata creation):
              - oeplatform-code/features/metaBuilder/index.md
          - 🚧 Open Peer Review:
              - oeplatform-code/features/open-peer-review-process/index.md
              - Technical docs: oeplatform-code/features/open-peer-review-process/technical-docs.md
          - Scenario Bundles:
              - oeplatform-code/features/scenario-bundles/index.md