helicon/mkdocs.yml at main · Lulzx/helicon · 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
site_name: Helicon
site_description: GPU-Accelerated Magnetic Nozzle Simulation & Detachment Analysis Toolkit
site_url: https://lulzx.github.io/helicon
repo_url: https://github.com/lulzx/helicon
repo_name: lulzx/helicon

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - content.code.annotate
    - content.code.copy

nav:
  - Home: index.md
  - Physics: physics.md
  - User Guide:
      - Installation: guide/install.md
      - Quick Start: guide/quickstart.md
      - Configuration: guide/configuration.md
      - Running Simulations: guide/running.md
      - Post-Processing: guide/postprocessing.md
      - Parameter Scans: guide/scans.md
      - Optimization: guide/optimization.md
      - Apple Silicon: guide/apple_silicon.md
      - Timing Reference: guide/timing.md
  - Validation:
      - Overview: validation/index.md
      - Free Expansion: validation/free_expansion.md
      - Guiding-Center Orbit: validation/guiding_center.md
      - Merino-Ahedo: validation/merino_ahedo.md
      - MN1D Benchmark: validation/mn1d_comparison.md
      - VASIMR VX-200: validation/vasimr.md
      - Resistive Detachment: validation/dimov.md
  - API Reference:
      - helicon.fields: api/fields.md
      - helicon.config: api/config.md
      - helicon.runner: api/runner.md
      - helicon.postprocess: api/postprocess.md
      - helicon.optimize: api/optimize.md
      - helicon.validate: api/validate.md
      - helicon.surrogate: api/surrogate.md
      - helicon.detach: api/detach.md
      - helicon.perf: api/perf.md
  - FAQ: faq.md
  - Contributing: contributing.md
  - Changelog: changelog.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: true
            show_root_heading: true
            show_category_heading: true
            merge_init_into_class: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html
  - tables

extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/lulzx/helicon

docs_dir: docs_src
site_dir: docs

watch:
  - src/helicon/