pytest-ipynb2/mkdocs.yml at main · MusicalNinjaDad/pytest-ipynb2 · 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
site_name: "pytest-ipynb2"
repo_url: https://github.com/MusicalNinjaDad/pytest-ipynb2
repo_name: MusicalNinjaDad/pytest-ipynb2

watch:
- pytest_ipynb2 # To update live preview when docstrings change

nav:
  - index.md
  - plugin.md
  - test_helpers.md
  - parser.md

theme:
  name: "material"
  icon:
    logo: material/test-tube
  palette: # Palette toggles for auto-light-dark mode
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/link
      name: Switch to light mode
  - media: "(prefers-color-scheme: light)"
    scheme: default
    toggle:
      icon: material/toggle-switch
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    toggle:
      icon: material/toggle-switch-off-outline
      name: Switch to system preference
  features:
    - navigation.expand
    - navigation.path
    - toc.integrate
    - navigation.indexes

plugins:
- search
- mkdocstrings:
    handlers:
      python:
        options:
          show_bases: false
          show_root_heading: true
          heading_level: 2
          show_root_full_path: false
          show_symbol_type_toc: true
          show_symbol_type_heading: true
          signature_crossrefs: true
          separate_signature: true
          show_signature_annotations: true
          show_source: false
          docstring_section_style: spacy
          docstring_options:
            ignore_init_summary: true
          merge_init_into_class: true

markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.snippets:
    url_download: true
    base_path: !relative $docs_dir
- pymdownx.superfences
- attr_list
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg