envelope-backup/mkdocs.yml at main · FLAIROx/envelope-backup · 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
site_name: 💌 Envelope
site_description: A JAX-native environment interface
site_url: https://envelope.readthedocs.io
repo_url: https://github.com/keraJLi/envelope
repo_name: keraJLi/envelope
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: red
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

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

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: red
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference


  features:
    - navigation.instant
    - navigation.sections
    - header.autohide

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_docstring_attributes: true
            group_by_category: true
            show_category_heading: true
            show_signature: true
            separate_signature: false
            show_if_no_docstring: false
            heading_level: 3
            filters:
              - "!^_"
          paths:
            - src

nav:
  - Home: index.md
  - Environments: api/environments.md
  - Spaces: api/spaces.md
  - Wrappers: api/wrappers.md
  - Adapters: api/adapters.md
  - Struct: api/struct.md