PyThrust/mkdocs.yml at main · Setuav/PyThrust · 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
site_name: PyThrust
site_description: Electric propulsion system co-design, analysis, and optimization framework for UAVs
site_author: Hüseyin Karakaya
repo_url: https://github.com/Setuav/PyThrust
repo_name: Setuav/PyThrust
edit_uri: edit/main/docs/

theme:
  name: material
  logo: images/setuav_logo.png
  favicon: images/setuav_logo.png
  font:
    text: Ubuntu
    code: Ubuntu Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - User Guide:
      - Home: index.md
      - Getting Started: getting_started.md
      - Propulsion Solver: usage.md
      - Motor Calibration: motor_calibration.md
      - Examples: examples.md
  - Reference:
      - API Reference: api_reference.md
      - Propulsion and Battery Theory: theory.md
      - Battery Model: battery_model.md
      - Component Databases: databases.md
  - Developer Guide:
      - Development & Testing: development.md