proteus/mkdocs.yml at main · Olympus-HPC/proteus · 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
site_name: Proteus
site_url: https://olympus-hpc.github.io/proteus/

nav:
  - Home: index.md
  - User's guide:
      - Installation: user/install.md
      - Build System Integration: user/integration.md
      - User Interface:
          - Overview: user/interface.md
          - Code Annotations: user/annotations.md
          - Python Bindings: user/python-bindings.md
          - C++ Frontend API: user/cpp-frontend.md
          - LLVM IR Frontend API: user/llvmir-frontend.md
          - MLIR Frontend API: user/mlir-frontend.md
          - DSL API: user/dsl.md
      - Runtime Configuration: user/config.md
      - Resources : user/resources.md
  - Developer's manual:
    - Concepts: dev/concepts.md
    - Proteus Internals:
      - Overview: dev/proteus-internals.md
      - Optimization Pipeline: dev/optimization-pipeline.md
    - Python Wheel Build: dev/python-wheel.md
    - Detecting CUDA Toolchain: dev/runtime-cuda-toolchain.md
    - Detecting HIP Assets: dev/runtime-hip-toolchain.md
    - Creating a PR: dev/pr.md
    - API Reference: dev/api.md
repo_url: https://github.com/Olympus-HPC/proteus
theme:
  name: material
  features:
    - toc.integrate
  logo: assets/proteus-logo.png
  favicon: assets/proteus-logo.png
  palette:
    scheme: default
    primary: light blue
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
plugins:
  - search
  - mike:
      alias_type: redirect
      canonical_version: latest
extra:
  version:
    provider: mike
    default: latest
    alias: true
extra_css:
  - stylesheets/extra.css
copyright: Copyright &copy; 2024 - 2026 Lawrence Livermore National Security, LLC and Proteus project contributors.