libxstream/mkdocs.yml at main · hfp/libxstream · 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
site_name: LIBXSTREAM
site_author: Hans Pabst
copyright: Copyright (c) LIBXSTREAM Contributors
site_description: Library and accelerator backend.
repo_url: https://github.com/hfp/libxstream/
edit_uri: edit/main/documentation
site_url: https://libxstream.readthedocs.io/
docs_dir: documentation

markdown_extensions:
- toc:
    permalink: True
    toc_depth: 3
    title: None
- pymdownx.highlight:
    anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.details
- md_in_html
- admonition
- attr_list
extra_css:
- style.css

theme:
    name: readthedocs
    custom_dir: .theme

extra:
  collapsed_nav:
    - "Samples"
    - "Tests"
    - "More"

plugins:
  - search

hooks:
  - .theme/hook.py

nav:
- Overview: index.md
- Presentations: libxstream_present.md
- Domains:
  - "OpenCL": libxstream_opencl.md
  - "DBCSR": libxstream_dbcsr.md
  - "CP2K": libxstream_cp2k.md
- Samples:
  - Stencil: samples/libxstream_stencil.md
  - Ozaki: samples/libxstream_ozaki.md
  - SMM: samples/libxstream_smm.md
- Tests:
  - Predict: tests/predict.md
- More:
  - Development: libxstream_scripts.md
  - LIBXS: libxstream_libxs.md