-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
100 lines (91 loc) · 2.7 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: FANTASTX Documentation
docs_dir: Docs
theme:
name: material
palette:
- scheme: default
primary: blue grey
accent: blue grey
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: blue grey
accent: blue grey
toggle:
icon: material/brightness-4
name: Switch to light mode
site_url: ""
use_directory_urls: false
# Repository
repo_name: MaterialEyes/fantastx
repo_url: https://github.com/MaterialEyes/fantastx
plugins:
# - search # commented for 'build'
- mkdocstrings:
handlers:
python:
selection:
docstring_style: google
- mkdocs-jupyter
# execute: false
# allow_errors: true
# kernel_name: python3
- git-revision-date
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/MaterialEyes/fantastx
markdown_extensions:
- tables
- admonition
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- pymdownx.arithmatex:
generic: true
- pymdownx.tabbed:
alternate_style: 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_css:
- custom.css
site_url: https://fantastx.github.io/
nav:
- Home: index.md
- Installation: installation.md
- FANTASTX YAML Preparation: YAML_PREP.md
- Structural relaxation input files: energy.md
- XANES YAML inputs: xanes.md
- Running FANTASTX: run.md
- Examples:
- Grain Boundary TEM: gb_tem_example.md
- Visualizing FANTASTX results: CdTe_Tellurene_Analysis.ipynb
- Bulk PDF: iro2_pdf_example.md
# - Molecule XANES: mol_xanes_example.md
# - FAQs: FAQs.md
- Citation: citation.md
- API:
- run_ops: run_ops-reference.md
- inputs: inputs-reference.md
- structure_record: structure_record-reference.md
- initial_population: initial_population-reference.md
- structure_operations: structure_operations-reference.md
- energy: energy-reference.md
- experimental_simulation: experimental_simulation-reference.md
- selection: selection-reference.md
- dominance: dominance-reference.md
- epsilonSelection: epsilonSelection-reference.md
- clusteredSelection: clusteredSelection-reference.md
- fingerprinting: fingerprinting-reference.md
- clustering: clustering-reference.md
- distance_check: distance_check-reference.md