cmtj/mkdocs.yml at master · LemurPwned/cmtj · 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
site_name: CMTJ
site_url: https://lemurpwned.github.io/cmtj/
site_author: LemurPwned

repo_url: https://github.com/LemurPwned/cmtj
repo_name: LemurPwned/cmtj

edit_uri: ""

hooks:
  - scripts/readme_copy.py

nav:
  - Home: index.md
  - Start here!: overview.md
  - Changelog: changelog.md
  - Tips & Tricks: tipsandtricks.md
  - Theory:
      - Macromagnetic contributions: physics/contributions.md
      - LLG Equation & solvers: physics/macromagnetic_models.md
      - Symbolic models: physics/sb-model.md
      - Linearisation: physics/linearisation.md
  - Experimental:
      - Introduction: experimental-methods/introduction.md
      - CIMS: experimental-methods/CIMS.ipynb
      - Harmonic Hall: experimental-methods/HarmonicsFits.ipynb
      - Misc experiments: experimental-methods/examples.ipynb
      - Spin Diode experiments: experimental-methods/VoltageSpinDiodeFits.ipynb
  - Parallelism: physics/parallelism.md
  - Tutorial (LLM-generated):
      - Index: autogen/index.md
      - Procedures: autogen/01_pimm___vsd_procedures_.md
      - Utilities: autogen/02_fieldscan_utilities_.md
      - Drivers: autogen/03_time_dependent_drivers__scalardriver___axialdriver__.md
      - Layers: autogen/04_magnetic_layer_models__layersb___layerdynamic__.md
      - Domain models: autogen/05_domain_wall_dynamics__domainwalldynamics___multilayerwalldynamics__.md
      - Noise: autogen/07_noise_generation_models_.md
      - Vector objects: autogen/09_vector_objects__cvector___vectorobj__.md
      - Energy solvers: autogen/10_sb_solver__solver__.md

  - API:
      - Core: api/core.md
      - Drivers: api/drivers.md
      - Models:
          - Smit-Beljers: api/models/sb-general-reference.md
          - Domain wall: api/models/dw-reference.md
      - Utils:
          - Resistance: api/resistance-reference.md
          - Linear: api/linear-reference.md
          - Filters: api/filters-reference.md
          - Energy: api/energy-reference.md
          - Plotting: api/plotting-reference.md
          - Procedures: api/procedures-reference.md
          - Parallel: api/parallel-reference.md
          - Optimization: api/optimization-reference.md
          - Ensemble models: api/ensemble-reference.md
          - Miscellanous: api/general-reference.md
      - Stack: api/stack.md
      - Noise: api/noise.md
      - LLGB: api/llgb.md
      - Group interactions: api/reservoir.md
  - Examples:
      - Library introduction: tutorials/CMTJBindingsTutorial.ipynb
      - Trajectories: tutorials/trajectory.ipynb
      - Smit-Beljers: tutorials/SBModel.ipynb
      - Interactions: tutorials/interactions.ipynb
      - Simple Harmonic Hall voltage detection: tutorials/simpler_harmonics.ipynb

theme:
  icon:
    repo: material/github
  name: "material"
  logo: assets/icon.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

plugins:
  - search
  - mermaid2
  - mkdocstrings:
      handlers:
        python:
          selection:
            docstring_style: sphinx

  - mkdocs-jupyter:
      include_source: True
  - git-revision-date:
      enabled_if_env: CI
      enable_creation_date: true

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      # make exceptions to highlighting of code:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
extra_javascript:
  - javascripts/config.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra:
  version:
    provider: mike