fastapi-taskflow/mkdocs.yml at main · Attakay78/fastapi-taskflow · 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
site_name: FastAPI-TaskFlow
site_description: Retries, persistence, and visibility for FastAPI's BackgroundTasks. Production-grade background tasks. No workers, no brokers, drop-in.
site_url: https://attakay78.github.io/fastapi-taskflow/
repo_url: https://github.com/Attakay78/fastapi-taskflow
repo_name: fastapi-taskflow
edit_uri: ""

theme:
  name: material
  custom_dir: docs/overrides
  logo: logo.svg
  favicon: favicon.svg
  font:
    text: Geist
    code: Geist Mono
  palette:
    - scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - toc.follow
    - content.code.copy
    - content.code.annotate

extra_css:
  - stylesheets/extra.css

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
  - Guide:
    - Setting Up TaskManager: guide/task-manager.md
    - Setting Up TaskAdmin: guide/task-admin.md
    - Defining Tasks: guide/defining-tasks.md
    - Injection Patterns: guide/injection.md
    - Adding Tasks: guide/adding-tasks.md
    - Task Logging: guide/logging.md
    - Task Context: guide/task-context.md
    - Observability: guide/observability.md
    - File Logging: guide/file-logging.md
    - Argument Encryption: guide/encryption.md
    - Concurrency Controls: guide/concurrency.md
    - Process Executor: guide/process-tasks.md
    - Named Queues: guide/named-queues.md
    - Priority Queues: guide/priority-queues.md
    - Eager Dispatch: guide/eager-dispatch.md
    - Scheduled Tasks: guide/scheduled-tasks.md
    - Persistence: guide/persistence.md
    - Pending Requeue: guide/requeue.md
    - Custom Backends: guide/backends.md
    - Dashboard: guide/dashboard.md
    - Authentication: guide/authentication.md
    - Multi-Instance Deployments: guide/multi-instance.md
  - API Reference:
    - TaskManager: api/task-manager.md
    - TaskAdmin: api/task-admin.md
    - ManagedBackgroundTasks: api/managed-background-tasks.md
    - task_log: api/task-log.md
    - Loggers: api/task-file-logger.md
    - Models: api/models.md
    - Backends: api/backends.md
    - Scheduled Tasks: api/scheduled-tasks.md
  - Examples: examples.md
  - Changelog: changelog.md
  - Contributing: contributing.md