IRMA/mkdocs.yml at main · ramic-k/IRMA · 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
site_name: IRMA
# Broken in-page anchors are INFO by default, which `mkdocs build --strict`
# does not fail on (it fails on WARNING and above), so a renamed heading with
# a stale #fragment link would pass. Promote them to warnings.
validation:
  links:
    anchors: warn
site_description: >-
  (In)elastic Representation of Materials As S(α,β) evaluations: thermal
  neutron scattering law generation, instrument spectra, and Monte Carlo
  transport kernels from one phonon model
site_url: https://ramic-k.github.io/IRMA/
repo_url: https://github.com/ramic-k/IRMA
theme:
  name: material
  palette:
    - scheme: default
      primary: teal
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - search.suggest
markdown_extensions:
  - admonition
  - attr_list
  - tables
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: ["."]          # repo root -> include the top-level CHANGELOG.md
      check_paths: true
  - pymdownx.arithmatex:
      generic: true
extra_javascript:
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
nav:
  - Home: index.md
  - Getting started:
      - Installation: installation.md
      - Quickstart: quickstart.md
      - The GUI: gui.md
  - Tutorials:
      - "ENDF evaluation from a phonopy calculation": tutorials/endf-evaluation.md
      - "Structure to spectrum with a MLIP": tutorials/structure-to-spectrum.md
      - "A transport material for NCrystal": tutorials/deck-to-transport.md
  - User guide:
      - Scattering modes: modes.md
      - Preparing a phonopy calculation: phonopy-input.md
      - Neutron scattering spectra: spectra.md
      - DOS-based spectra (mode 0): spectra-mode0.md
      - Automatic grids: grids.md
      - Input file reference: input-reference.md
      - Crystalline extinction: extinction.md
      - NJOY interoperability: njoy.md
      - NCrystal data exporter: ncrystal-plugin.md
      - MLIP phonon calculations: mlip.md
      - MLIP examples: mlip-examples.md
  - Validation:
      - Methodology: validation/methodology.md
      - Graphite: validation/graphite.md
      - Beryllium: validation/beryllium.md
      - Beryllium oxide: validation/beryllium-oxide.md
  - Background:
      - Theory: theory.md
  - Troubleshooting: troubleshooting.md
  - Changelog: changelog.md