kubesplit/mkdocs.yml at main · looztra/kubesplit · 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
---
site_name: Kubesplit
site_url: https://looztra.github.io/kubesplit/
site_description: Split multidoc YAML Kubernetes descriptors into a set of single-resource files.
repo_url: https://github.com/looztra/kubesplit
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
  - redirects:
      redirect_maps:
        install.md: how-to/install.md
        usage.md: how-to/split-descriptors.md
nav:
  - Home: index.md
  - Tutorials:
      - Getting started: tutorials/getting-started.md
  - How-to guides:
      - Install: how-to/install.md
      - Split descriptors: how-to/split-descriptors.md
      - Organize the output: how-to/organize-output.md
      - Control quotes: how-to/control-quotes.md
      - Tune the YAML formatting: how-to/tune-yaml-formatting.md
      - Use with Kustomize and Helm: how-to/integrate-kustomize-helm.md
  - Reference:
      - CLI options: reference/cli.md
      - File naming and layout: reference/file-naming.md
      - Public API: reference/api.md
      - Changelog: changelog.md
  - Explanation:
      - How kubesplit works: explanation/how-it-works.md
      - Ecosystem: explanation/ecosystem.md
  - Contributing: contributing.md
watch:
  - src