MVB/mkdocs.yml at main · OpenMagnetics/MVB · 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
site_name: OpenMagnetics Virtual Builder
site_url: https://openMagnetics.github.io/MVB
site_description: Generate 3D models, meshes, and technical drawings for magnetic components
repo_url: https://github.com/OpenMagnetics/MVB
repo_name: OpenMagnetics/MVB

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2
            members_order: source
            docstring_style: google
            show_signature_annotations: true
            separate_signature: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.mark
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

extra_css:
  - assets/stylesheets/extra.css

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
  - Architecture:
    - Overview: architecture/overview.md
    - Engines: architecture/engines.md
    - Shape Hierarchy: architecture/shape-hierarchy.md
    - Data Flow: architecture/data-flow.md
  - API Reference:
    - Builder: api/builder.md
    - CadQuery Builder: api/cadquery-builder.md
    - FreeCAD Builder: api/freecad-builder.md
    - 2D Drawings: api/drawing-2d.md
    - Utilities: api/utils.md
    - Shape Configs: api/shape-configs.md
    - Magnetic Builder: api/magnetic-builder.md
  - Tutorials:
    - Core Generation: tutorials/core-generation.md
    - Complete Magnetic: tutorials/complete-magnetic.md
    - Technical Drawings: tutorials/technical-drawings.md
    - Toroidal Winding: tutorials/toroidal-winding.md
    - C-Core Example: tutorials/c-core-example.md
  - Shape Catalog:
    - Overview: shapes/index.md
    - E Family: shapes/e-family.md
    - P Family: shapes/p-family.md
    - Planar Family: shapes/planar-family.md
    - U Family: shapes/u-family.md
    - Toroidal: shapes/toroidal-family.md
    - C Cores: shapes/c-family.md
  - Testing:
    - Guide: testing/guide.md
  - Contributing: contributing.md
  - Changelog: changelog.md