WEC-Grid/mkdocs.yml at main · acep-uaf/WEC-Grid · 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
144
145
146
site_name: WEC-Grid
site_description: Integrating Wave Energy Converter Models into Power System Simulations
site_url: https://acep-uaf.github.io/WEC-Grid/   # helps SEO + sitemap

repo_url: https://github.com/acep-uaf/WEC-Grid
repo_name: acep-uaf/WEC-Grid
edit_uri: edit/main/docs/   # adjust if your docs folder differs

theme:
  name: material
  logo: assets/WEC-Grid_mini_white_circle.png
  features:
    - content.action.edit
    - content.action.view
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - toc.integrate
    - navigation.tracking
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.footnote.tooltips
    - header.autohide
  palette:
    - scheme: default
      primary: gray
      accent: black
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: gray
      accent: black
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

markdown_extensions:
  - admonition
  - footnotes
  - attr_list
  - pymdownx.details
  - pymdownx.mark
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.snippets

extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js   # optional: diagrams

extra_css:
  - assets/custom.css

extra:
  version: 1.0.0
  history_buttons: true
  article_nav_top: true
  article_nav_bottom: true
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/acep-uaf/WEC-Grid
  # alternate:
  #   - name: favicon
  #     link: assets/WEC-Grid_mini_white.png
  # social_image: assets/social-card.png   # optional: for link previews

plugins:
  - search
  - glightbox
  - autorefs
  - git-revision-date-localized:
      enable_creation_date: true
      type: date
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            merge_init_into_class: true
            show_if_no_docstring: false
            show_signature: true
            separate_signature: true
            show_signature_annotations: true
            show_source: true
            show_inheritance: true
            show_bases: false
            inherited_members: true
            members_order: source
            filters: ["!^_"]
            show_object_full_path: true
  - mkdocs-jupyter:
      include: ["*.ipynb"]
      execute: false
      include_requirejs: true
      include_source: true
      ignore_h1_titles: true
      allow_errors: false

nav:
  - Home: index.md
  - Getting Started:
      - Software Design: design.md
      - Installation: install.md
  - WEC-Grid:
      - Engine: wecgrid/engine.md
      - Modelers:
          - Power System:
              - Base Class: wecgrid/base.md
              - PSS®E: wecgrid/psse.md
              - PyPSA: wecgrid/pypsa.md
          - Wave Energy Converter:
              - WEC-Sim: wecgrid/wecsim.md
      - WEC:
          - WEC Farm / Device: wecgrid/wec.md
      - Util:
          - Database: wecgrid/database.md
          - Time: wecgrid/time.md
          - Plot: wecgrid/plot.md
  - Examples:
      - Example 1: examples/example1.ipynb
      - Example 2: examples/example2.ipynb
      - Example 3: examples/example3.ipynb
      - Example 4: examples/example4.ipynb
  - Data:
      - Grid Models: data/grid-models.md
      - WEC Models: data/wec-models.md
      - Preloaded Database: data/preloaded_database.md
  - Reference:
      - Performance Metrics: reference/performance_metrics.md
      - Troubleshooting: reference/troubleshooting.md
      - Citation: reference/citation.md