numerous-widgets/mkdocs.yml at main · numerous-com/numerous-widgets · 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
site_name: numerous-widgets docs
nav:
  - Home: README.md
  - Our Website: https://numerous.com
  - Our GitHub Page: https://github.com/numerous-com/numerous-widgets
  - Our PyPI Page: https://pypi.org/project/numerous-widgets/
  - Platform Docs: https://numerous.com/docs
  - API Reference:
    - Widgets: widgets.md
    - Save & Load: save_load_widget.md
    - Process Task: process_task.md
    - State Model: state_model.md
    - Templating: templating.md
    - Styling: styling.md

theme:
  name: material
  logo: logo.svg
  favicon: favicon.png
  features:
      - content.code.copy
  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
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference


plugins:
  - search
  - gen-files:
      scripts:
        - scripts/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      default_handler: "python"
      handlers:
        python:
          setup_commands:
            - "import sys; sys.path.insert(0, './python/src/numerous')"
          paths: [./python/src/numerous]
          import:
            - https://docs.python.org/3/objects.inv
          rendering:
            show_source: true
            show_full_signature: true
            show_root_heading: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences