patchdiff/mkdocs.yml at master · fork-tongue/patchdiff · 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
site_name: Patchdiff
site_description: Bi-directional, JSON-patch compliant diffs between composite Python data structures
site_url: https://fork-tongue.github.io/patchdiff
repo_url: https://github.com/fork-tongue/patchdiff
repo_name: fork-tongue/patchdiff

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            heading_level: 3
            members_order: source
            separate_signature: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quick-start.md
  - Guide:
      - Diffing: guide/diffing.md
      - Applying Patches: guide/applying.md
      - JSON Pointers: guide/pointers.md
      - Proxy-Based Patch Generation: guide/produce.md
      - Serialization: guide/serialization.md
      - Observ Integration: guide/observ.md
      - Gotchas: guide/gotchas.md
  - Reference:
      - API Reference: reference/api.md
  - Internals:
      - Architecture: internals/architecture.md