omniray/mkdocs.yml at main · omniviser/omniray · 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
site_name: OMNIRAY
site_url: https://omniviser.github.io/omniray/
site_description: Automatic tracing for Python. Stop guessing. Debug effortlessly. You and your AI can now see everything.
repo_url: https://github.com/omniviser/omniray
repo_name: omniviser/omniray
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/icon-white-200.png
  favicon: assets/favicon.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.sections
    - navigation.indexes
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - toc.integrate
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search

nav:
  - Home: index.md
  - Getting Started: getting-started/index.md
  - Guide:
      - guide/index.md
      - "@trace Decorator": guide/trace-decorator.md
      - Custom Wrappers: guide/custom-wrappers.md
      - Configuration: guide/configuration.md
  - Reference:
      - reference/index.md
      - API Reference: reference/api.md
      - Performance: reference/performance.md
  - Examples:
      - examples/index.md
      - Basic Logging: examples/basic-logging.md
      - Execution Timing: examples/basic-timing.md