xdsl/mkdocs.yml at main · positr0nium/xdsl · 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
site_name: xDSL
site_url: https://xdsl.readthedocs.io/
site_description: xDSL -- a Python-native compiler framework
site_author: xDSL developers
copyright: Copyright &copy xDSL developers
repo_name:  xdslproject/xdsl
repo_url: https://github.com/xdslproject/xdsl

strict: true

theme:
  name: "material"
  logo: assets/img/logos/xdsl-transparent-single.png
  favicon: assets/img/logos/xdsl-transparent-single.png
  locale: en
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.indexes
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: xdsl
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

plugins:
- search
- gen-files:
    scripts:
    - scripts/gen_ref_pages.py
- awesome-nav
- marimo
- mkdocstrings:
    handlers:
      python:
        options:
          docstring_style: google
          members_order: source
          show_root_heading: true
          show_root_full_path: false
          show_signature_annotations: true
          show_if_no_docstring: true
- mkdocs-simple-hooks:
    hooks:
      on_post_build: "scripts.hooks:build_xdsl_wheel"

extra:
  social:
    - icon: material/rss
      link: https://xdsl.dev/feed.xml
      name: Subscribe to our RSS Feed
    - icon: material/chat
      link: https://xdsl.zulipchat.com/
      name: Chat on Zulip
    - icon: material/github
      link: https://github.com/xdslproject
      name: Contribute on Github