numen/mkdocs.yml at main · TalbotKnighton/numen · 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
site_name: Numen
site_description: Hybrid Python/Julia physics simulation framework
site_url: https://TalbotKnighton.github.io/numen/
repo_url: https://github.com/TalbotKnighton/numen
repo_name: TalbotKnighton/numen

theme:
  name: material
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - toc.integrate
    - search.suggest

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            docstring_style: google
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true

nav:
  - Home: index.md
  - Guided Tour: tour.md
  - Getting Started: getting-started.md
  - User Guide:
    - Components & Fields: guide/components.md
    - Systems & Dynamics: guide/systems.md
    - Backends: guide/backends.md
    - Characterization: guide/characterization.md
  - Examples:
    - Python:
      - Oscillator: examples/oscillator.md
      - Coupled Spring: examples/coupled_spring.md
      - Fluid Poppet: examples/fluid_poppet.md
    - Julia dynamics files:
      - Oscillator: examples/oscillator_julia.md
      - Coupled Spring: examples/coupled_spring_julia.md
      - Fluid Poppet: examples/fluid_poppet_julia.md
      - Pneumatic Dashpot: examples/pneumatic_dashpot_julia.md
  - API Reference:
    - Fields: api/fields.md
    - Compiler: api/compiler.md
    - Backends: api/backends.md
    - Reconstruction: api/reconstruction.md
  - Julia Reference: julia.md