bydantic/mkdocs.yml at main · khusmann/bydantic · 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
site_name: Bydantic
site_url: https://bydantic.kylehusmann.com
repo_url: https://github.com/khusmann/bydantic

nav:
  - Welcome to Bydantic: index.md
  - Getting Started: getting-started.md
  - More Field Types: more-field-types.md
  - Complex Data Structures: complex-data-structures.md
  - Global Context: global-context.md
  - Field Type Reference: field-type-reference.md
  - Bitfield Class Reference: bitfield-class-reference.md

theme:
  name: material
  custom_dir: overrides
  features:
    - content.code.copy

extra:
  analytics:
    provider: goatcounter
    code: bydantic

watch:
  - src

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            separate_signature: true
            show_signature_annotations: true
            show_overloads: false
            annotations_path: brief
            docstring_style: google
            show_root_heading: true
            show_root_full_path: false
            show_source: false
  - gen-files:
      scripts:
        - update_readme.py