PyRays/mkdocs.yml at main · bateman/PyRays · 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
# Project information
site_name: PyRays
site_url: https://github.com/bateman/PyRays
site_description: A Python + UV template project.
site_author: bateman <fcalefato@gmail.com>

# Repository
repo_url: https://github.com/bateman/PyRays
repo_name: bateman/PyRays
edit_uri: "" #disables edit button

# Copyright
copyright: MIT License 2025

# Configuration
theme:
  name: material
  language: en
  logo: images/logo.png
  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: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - github-callouts

plugins:
  - search
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true

nav:
  - Home: index.md
  - Documentation:
    - Module: module.md
    - Configuration: config.md
    - Logging: logging.md
    - Project Info: info.md
  - Info:
    - About: about.md
    - License: license.md