inline-snapshot/mkdocs.yml at main · 15r10nk/inline-snapshot · 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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
site_name: inline-snapshot
site_url: https://15r10nk.github.io/inline-snapshot/
repo_url: https://github.com/15r10nk/inline-snapshot/
edit_uri: edit/main/docs

theme:
  name: material
  custom_dir: docs/theme
  logo: assets/favicon.svg
  favicon: assets/favicon.svg
  features:
  - toc.follow
  - content.code.annotate
  - navigation.tabs
  - navigation.expand

  palette:
  - media: (prefers-color-scheme)

    # Palette toggle for light mode
  - scheme: default
    media: '(prefers-color-scheme: light)'
    primary: teal

    # Palette toggle for dark mode
  - scheme: slate
    media: '(prefers-color-scheme: dark)'
    primary: teal

validation:
  links:
    absolute_links: relative_to_docs


watch:
- CONTRIBUTING.md
- CHANGELOG.md
- README.md
- src/inline_snapshot
- changelog.d

nav:
- Home:
  - Introduction: index.md
  - Configuration: configuration.md
  - Integrations:
    - Pytest: pytest.md
    - PyCharm: pycharm.md
  - Categories: categories.md
  - Plugin: plugin.md
  - Code generation: code_generation.md
  - Limitations: limitations.md
  - Alternatives: alternatives.md
  - Changelog: changelog.md
- Core:
  - assert x == ...: fix_assert.md
  - snapshot:
    - x == snapshot(): eq_snapshot.md
    - x <= snapshot(): cmp_snapshot.md
    - x in snapshot(): in_snapshot.md
    - snapshot()[key]: getitem_snapshot.md
  - snapshot_arg.md
  - external:
    - external(): external/external.md
    - external_file(): external/external_file.md
    - outsource(): external/outsource.md
    - '@register_format()': external/register_format.md
  - '@customize_repr': customize_repr.md
  - types: types.md
  - get_snapshot_value(): get_snapshot_value.md
- HowTo:
  - pytest parametrize: howto/parametrize.md
- Extensions:
  - first-party (extra): extra.md
  - third-party: third_party.md
- Insiders: insiders.md
- Development:
  - Testing: testing.md
  - Contributing: contributing.md


markdown_extensions:
- toc:
    permalink: true
- admonition
- pymdownx.highlight:
    anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets:
    check_paths: true
- pymdownx.superfences
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
- attr_list
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
- mkdocstrings:
    handlers:
      python:
        inventories:
        - https://docs.python.org/3/objects.inv
        options:
          show_symbol_type_heading: true
          show_symbol_type_toc: true
- social
- search
- markdown-exec:
    ansi: required
- replace-url
- autorefs
- redirects:
    redirect_maps:
      outsource.md: external/outsource.md
- llmstxt:
    sections:
      Overview:
      - index.md
      - configuration.md
      - pytest.md
      - categories.md
      - code_generation.md
      - limitations.md
      Core Reference:
      - fix_assert.md
      - eq_snapshot.md
      - cmp_snapshot.md
      - in_snapshot.md
      - getitem_snapshot.md
      - external/*.md
      - customize_repr.md
      - types.md
      HowTo:
      - howto/*.md
      Extensions:
      - extra.md
      - third_party.md

extra_css:
- styles/extra.css

extra:
  social:
  - icon: fontawesome/brands/x-twitter
    link: https://x.com/15r10nk
  - icon: fontawesome/brands/mastodon
    link: https://fosstodon.org/@15r10nk
  version:
    provider: mike
    default:
    - latest
    - development