jaxquantum/mkdocs.yml at main · EQuS/jaxquantum · 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
site_name: jaxquantum
site_url: https://jaxquantum.org
use_directory_urls: false
repo_url: https://github.com/EQuS/jaxquantum
repo_name: jaxquantum

exclude_docs: |
  scripts/

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - content.code.copy
  logo: assets/logo.png
  favicon: assets/favicon.ico
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: purple
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: purple
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
copyright: "&copy Copyright 2022-2025, JAXQuantum developers."
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/EQuS/jaxquantum
watch:
  - docs
  - jaxquantum
plugins:
  - search
  - mkdocs-jupyter:
      execute: true
      include: ["*.ipynb"]
  - gen-files:
      scripts:
      - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: summary.md
  - section-index
  - mkdocstrings
markdown_extensions:
  - toc
  - admonition
  - attr_list
  - md_in_html
  - codehilite
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - "."
        - "docs"
      check_paths: true
  - pymdownx.details
  - pymdownx.tabbed
  - pymdownx.extra
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true

extra_css:
  - stylesheets/landing.css

extra_javascript:
  - js/mathjax-config.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - About:
    - index.md
    - Overview: about/overview.md
    - Community: about/community.md
    - Contributors: about/contributors.md
    - Citation: about/citation.md
  - Documentation:
    - documentation/index.md
    - Getting Started:
      - Installation: documentation/getting_started/installation.md
      - NVIDIA GPU on Windows: documentation/getting_started/gpu_windows.md
      - Profiling JAX code: documentation/getting_started/profiling.ipynb
      - Custom direct channels: documentation/getting_started/channels.md
      - Qarray: documentation/getting_started/qarray.ipynb
      - The Sharp Bits 🔪: documentation/getting_started/sharp_bits.md
    - Tutorials:
      - documentation/tutorials/index.md
      - Diffrax Solvers: documentation/tutorials/diffrax_solvers.ipynb
      - Devices & Systems: documentation/tutorials/devices.ipynb
      - Bosonic Codes: documentation/tutorials/bosonic_codes.ipynb
      - Circuits: documentation/tutorials/circuits.ipynb
      - Sparse Backends: documentation/tutorials/sparse_backends.ipynb
      - Sharding: documentation/tutorials/sharding.ipynb
  - Code Reference: reference/