sheppy/mkdocs.yml at master · malvex/sheppy · 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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
site_name: Sheppy
site_url: https://docs.sheppy.org/

repo_name: malvex/sheppy
repo_url: https://github.com/malvex/sheppy

theme:
  name: material
  language: en
  palette:
    scheme: slate
    primary: black

  features:
    - content.code.annotate
    - content.code.copy
    - navigation.sections
    - navigation.footer
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - search.share
    - search.suggest

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Quickstart: getting-started/quickstart.md
    - getting-started/task-scheduling.md
    - getting-started/error-handling.md
    - getting-started/validation-with-pydantic.md
    - getting-started/testing.md
    - getting-started/cron.md
    - Advanced:
      - getting-started/advanced/fastapi-integration.md
  - API Reference:
    - Queue class: reference/queue.md
    - TestQueue class: reference/testqueue.md
    - CLI reference: reference/cli.md
    - Models:
      - Task: reference/task.md
      - TaskSpec: reference/task-spec.md
      - TaskConfig: reference/task-config.md
      - TaskCron: reference/task-cron.md
    - Backends:
      - Backend class: reference/backends/backend.md
      - RedisBackend class: reference/backends/redis-backend.md
      - MemoryBackend class: reference/backends/memory-backend.md
    - Advanced:
      - Worker class: reference/worker.md
  - Code Examples:
    - examples/index.md
  - Changelog: changelog.md
  - About:
    - About Sheppy: about/index.md
    - about/roadmap.md
    - about/license.md

plugins:
  search: null
  privacy: null
  mkdocstrings:
    handlers:
      python:
        options:
          filters:
            - '!^_'
            - "!model_config"
          show_root_heading: true
          show_if_no_docstring: true
          inherited_members: true
          members_order: source
          separate_signature: true
          unwrap_annotated: true
          merge_init_into_class: true
          docstring_section_style: spacy
          signature_crossrefs: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          show_labels: false
          overloads_only: true
          show_signature_annotations: true
          show_signature_type_parameters: true

markdown_extensions:
  # python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true

  # python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

  # code snippets
  - pymdownx.snippets:
      check_paths: true
      # base_path: examples/

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/malvex
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/sheppy/
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/malvex/sheppy