fluxqueue/mkdocs.yml at 58c0a0e001c4e5be20947d5aabecf8db1505650f · CCXLV/fluxqueue · 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
site_name: FluxQueue
site_description: A lightweight, resource-efficient, high-throughput task queue for Python, written in Rust.

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: amber
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: amber
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  highlightjs: true
  hljs_languages:
    - python
    - bash
    - yaml
    - json
  features:
    - content.code.copy
    - navigation.indexes
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - navigation.footer
  logo: images/logo_white.svg
  favicon: images/logo.svg
  language: en

repo_name: ccxlv/fluxqueue
repo_url: https://github.com/ccxlv/fluxqueue

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: true
            show_if_no_docstring: true
            members_order: source
            merge_init_into_class: true
            inherited_members: true
            separate_signature: true
            filters:
              - "!^_"
            show_symbol_type_heading: true
            show_symbol_type_toc: true

nav:
  - FluxQueue: index.md
  - Learn:
      - tutorial/index.md
      - tutorial/installation.md
      - tutorial/quickstart.md
      - tutorial/defininig_and_exposing_tasks.md
      - tutorial/worker.md
  - How it Works:
      - how-it-works/index.md
      - how-it-works/client.md
      - how-it-works/worker.md
  - Examples:
      - examples/index.md
      - examples/flask.md
      - examples/django.md
      - examples/fastapi.md
  - API Reference:
      - api/index.md
      - api/fluxqueue.md
      - api/environment.md
  - About: about.md

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

extra_css:
  - css/extra.css