-
Notifications
You must be signed in to change notification settings - Fork 9
/
mkdocs.yml
97 lines (83 loc) · 2.57 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
site_name: lume-astra
repo_url: https://github.com/ChristopherMayes/lume-astra
repo_name: "ChristopherMayes/lume-astra"
nav:
- Home: index.md
- Examples:
- Basic:
- examples/basic_astra_examples.ipynb
- examples/install_astra.ipynb
- examples/functional_astra_run.ipynb
- examples/simple_distgen_example.ipynb
- examples/simple_generator_example.ipynb
- Interfaces:
- examples/interfaces/astra_to_bmad.ipynb
- examples/interfaces/bmad_to_astra.ipynb
- Low Level:
- examples/scan_example.ipynb
- examples/plot_examples.ipynb
- Elements:
- examples/elements/apex_gun.ipynb
- examples/elements/drift.ipynb
- examples/elements/tws.ipynb
- examples/elements/tesla_9cell_cavity.ipynb
- API:
- Astra: api/astra.md
- Generator: api/generator.md
- Install: api/install.md
theme:
icon:
repo: fontawesome/brands/github
name: material
custom_dir: overrides
features:
- navigation.top
- navigation.tabs
- navigation.indexes
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/toggle-switch
name: Switch to light mode
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.arithmatex: # Enable MathJAX https://squidfunk.github.io/mkdocs-material/reference/mathjax/
generic: true
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra:
generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/ChristopherMayes/lume-astra
name: LUME-Astra
extra_css:
- stylesheets/extra.css
plugins:
- search
- mkdocs-jupyter:
include_source: True
- mkdocstrings:
default_handler: python
handlers:
python:
selection:
docstring_style: "numpy"
inherited_members: false
filters:
- "!^_" # exclude all members starting with _
- "^__init__$" # but always include __init__ modules and methods
rendering:
show_source: true
show_root_heading: true