yamkix/mkdocs.yml at main · looztra/yamkix · 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
---
site_name: Yamkix
site_url: https://looztra.github.io/yamkix/
site_description: Yamkix is an opinionated yaml file formatter.
repo_url: https://github.com/looztra/yamkix
edit_uri: edit/main/docs/
theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
  features:
    - content.action.edit
    - content.code.copy

validation:
  omitted_files: warn
  absolute_links: warn # Or 'relative_to_docs' - new in MkDocs 1.6
  unrecognized_links: warn
  anchors: warn # New in MkDocs 1.6

markdown_extensions:
  - toc:
      permalink: true
  - sane_lists
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - url: https://docs.python.org/3/objects.inv
              domains: [std, py]
          options:
            docstring_style: google
            separate_signature: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            extensions:
              - griffe_pydantic:
                schema: true
              - griffe_typingdoc
              - griffe_warnings_deprecated
  - git-revision-date-localized:
      enable_creation_date: false
      type: iso_datetime
nav:
  - Introduction: index.md
  - Configuration: configuration.md
  - Install: install.md
  - Usage: usage.md
  - Public API Reference: reference.md
  - Changelog: changelog.md
  - Contributing: contributing.md
  - Pointers: pointers.md
watch:
  - src