lightkube/mkdocs.yml at master · gtsystem/lightkube · 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
site_name: LightKube
theme:
  name: material
  hljs_style: monokai
  palette:
    primary: deep purple
  features:
    - content.tabs.link
    - content.code.copy

repo_name: gtsystem/lightkube
repo_url: https://github.com/gtsystem/lightkube
edit_uri: ""

nav:
  - QuickStart: index.md
  - Configuration: configuration.md
  - Reference:
      - Client: reference/client.md
      - AsyncClient: reference/async_client.md
      - Configuration: reference/configuration.md
      - Exceptions: reference/exceptions.md
      - Types: reference/types.md
  - Resources & Models: resources-and-models.md
  - Utils: utils.md
  - Advanced:
      - Selectors: selectors.md
      - Generic Resources: generic-resources.md
      - Custom Resources: custom-resources.md
      - Load/Dump Objects: codecs.md
      - List-Watch Pattern: list-watch.md

extra_css:
  - css/custom.css

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - markdown_include.include:
      base_path: .

plugins:
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        options:
          heading_level: 2
          show_root_heading: true
          show_symbol_type_heading: true
          show_signature_annotations: true
          signature_crossrefs: true
          show_if_no_docstring: true
          docstring_section_style: list
          filters: ["!^_[^_]"]
          merge_init_into_class: true