docket/mkdocs.yml at main · chrisguidry/docket · 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
80
81
site_name: docket
site_description: A distributed background task system for Python
site_url: https://docket.lol/
repo_url: https://github.com/chrisguidry/docket
repo_name: chrisguidry/docket

edit_uri: edit/main/docs/

theme:
  name: material
  icon:
    logo: material/clipboard-check-outline
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit
    - content.action.view
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

watch:
  - src

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/chrisguidry/docket
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pydocket/

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Task Behaviors: task-behaviors.md
  - Dependency Injection: dependency-injection.md
  - Task Design Patterns: task-patterns.md
  - Task Observability: observability.md
  - Testing with Docket: testing.md
  - Docket in Production: production.md
  - API Reference: api-reference.md