celery-asyncio/mkdocs.yml at main · oliverhaas/celery-asyncio · 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
site_name: celery-asyncio
site_description: Distributed task queue with native asyncio support
site_url: https://oliverhaas.github.io/celery-asyncio/
repo_url: https://github.com/oliverhaas/celery-asyncio
repo_name: oliverhaas/celery-asyncio
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: green
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            members_order: source
            show_signature_annotations: true
            separate_signature: true
            docstring_style: sphinx

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra:
  version:
    provider: mike

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Migration Guide: getting-started/migration.md
  - User Guide:
      - Architecture: user-guide/architecture.md
      - Async Tasks: user-guide/async-tasks.md
      - Configuration: user-guide/configuration.md
      - Django Integration: user-guide/django.md
  - API Reference:
      - Application: reference/app.md
      - Task: reference/task.md
      - Canvas: reference/canvas.md
      - Results: reference/result.md
      - Signals: reference/signals.md
      - Schedules: reference/schedules.md
      - States: reference/states.md
  - Changelog: reference/changelog.md