rose/mkdocs.yml at main · bandframework/rose · 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
site_name: ROSE

plugins:
- search
- mkdocs-jupyter
- mkdocstrings:
    handlers:
      python:
        paths: [src]
        options:
          docstring_options:
            ignore_init_summary: false
          merge_init_into_class: true

watch:
- src/rose

markdown_extensions:
- footnotes

theme:
  name: material
  features:
    - toc.integrate
    - content.action.edit

  palette:

    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github-alt
    edit: material/pencil
    view: material/eye

nav:
  - index.md
  - Tutorials:
    - tutorials/ROSE_tutorial_1_building_an_emulator.ipynb
    - tutorials/ROSE_tutorial_2_optical_potential_surmise_UQ.ipynb
  - Documentation:
    - hifi_solver.md
    - interaction.md
    - basis.md
    - rbe.md
    - sae.md
  - contact.md

extra_javascript:
  - javascripts/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js

extra_css:
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

repo_url: https://github.com/bandframework/rose

repo_name: bandframework/rose

edit_uri: edit/develop/docs/

copyright: Copyright &copy; 2022 - 2023 BAND Collaboration