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
site_name: cfsem
site_url: https://cfsem-py.readthedocs.io
theme:
name: material
logo: assets/logo.svg
palette:
primary: custom
accent: custom
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
heading_level: 3
show_root_heading: true
separate_signature: true
show_signature_annotations: true
nav:
- "About cfsem": index.md
- "Python Examples": "python/examples.md"
- "Python API":
- "python/filament.md"
- "python/flux_density.md"
- "python/vector_potential.md"
- "python/inductance.md"
- "python/grad_shafranov.md"
- "python/math.md"
- "python/types.md"
- "Rust API": "https://docs.rs/cfsem"
markdown_extensions:
- pymdownx.arithmatex:
generic: true
- toc:
permalink: true
- md_in_html
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
extra_css:
- stylesheets/extra.css
watch:
- cfsem
exclude_docs: |
rust/static.files/SourceSerif4-LICENSE-*.md