pydantic-gitlab-webhooks/mkdocs.yml at main · dukhaSlayer/pydantic-gitlab-webhooks · 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
site_name: "pydantic-gitlab-webhooks"
site_description: "Pydantic models for GitLab webhook request bodies"
site_url: "https://rjw57.github.io/pydantic-gitlab-webhooks"
repo_url: "https://github.com/rjw57/pydantic-gitlab-webhooks"
repo_name: "rjw57/pydantic-gitlab-webhooks"
site_dir: "site"
watch: [mkdocs.yml, README.md]
copyright: Copyright &copy; Rich Wareham
edit_uri: edit/main/docs/

nav:
  - Home:
      - Overview: index.md
      - Getting started: getting-started.md
      - Changelog: changelog.md
      - License: license.md
  - API reference:
      - reference/events.md
      - reference/validators.md
      - reference/other.md

theme:
  name: material
  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.snippets:
      base_path: [!relative $config_dir]
      check_paths: true
  - pymdownx.superfences
  - toc

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
          options:
            filters: ["!^_"]
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            show_source: false
            show_symbol_type_heading: true
            signature_crossrefs: true
            show_root_toc_entry: false