django-health-check/mkdocs.yml at cee39b3a620c4b8591bacef015e568ea454329be · codingjoe/django-health-check · 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
site_name: Django HealthCheck
repo_url: https://github.com/codingjoe/django-health-check
watch:
  - docs
  - health_check
nav:
  - Home: index.md
  - Installation: install.md
  - Usage: usage.md
  - Checks: checks.md
  - Cookbook: cookbook.md
  - Migration to v4.x: migrate-to-v4.md
  - Changelog: https://github.com/codingjoe/django-health-check/releases
  - Community Support: https://github.com/codingjoe/django-health-check/discussions
plugins:
  - autorefs
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          load_external_modules: true
          options:
            docstring_style: google
            show_root_heading: true
            heading_level: 3
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://docs.djangoproject.com/en/stable/objects.inv
            - https://www.psycopg.org/psycopg3/docs/objects.inv
            - https://docs.celeryq.dev/en/stable/objects.inv
            - https://psutil.readthedocs.io/en/stable/objects.inv
            - https://redis.readthedocs.io/en/stable/objects.inv
            - https://django-storages.readthedocs.io/en/stable/objects.inv
theme:
  name: material
  logo: images/icon.svg
  palette:
    - media: "(prefers-color-scheme)"
      primary: teal
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      primary: teal
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: teal
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - content.code.select
    - content.code.copy
    - search.suggest
    - search.share
markdown_extensions:
  - github-callouts
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.superfences