-
Notifications
You must be signed in to change notification settings - Fork 5
/
mkdocs.yml
100 lines (90 loc) · 2.82 KB
/
mkdocs.yml
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
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
- docs/docgen.py
nav:
- Home: index.md
- Overview: overview.md
- Changelog: changelog.md
- Tips & Tricks: tipsandtricks.md
- Theory:
- Macromagnetic contributions: physics/contributions.md
- LLG Equation & solvers: physics/macromagnetic_models.md
- Static Smit-Beljers model: physics/sb-model.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/paralellism.md
- API:
- Core: gen-docs/cmtj.md
- Drivers: gen-docs/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: gen-docs/stack.md
- Noise: gen-docs/noise.md
- LLGB: gen-docs/llgb.md
- Examples:
- Library introduction: tutorials/CMTJBindingsTutorial.ipynb
- Trajectories: tutorials/trajectory.ipynb
- Smit-Beljers: tutorials/SBModel.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
- 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
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