psygnal/mkdocs.yml at main · pyapp-kit/psygnal · 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
site_name: psygnal
site_url: https://github.com/pyapp-kit/psygnal
site_author: Talley Lambert
site_description: >-
  Pure python callback/event system modeled after Qt Signals

# Repository
repo_name: pyapp-kit/psygnal
repo_url: https://github.com/pyapp-kit/psygnal

# Copyright
copyright: Copyright &copy; 2021 - 2022 Talley Lambert

extra_css:
  - stylesheets/extra.css

watch:
  - src/psygnal

nav:
  - Overview: index.md
  - Usage: usage.md
  - Guides:
    - Evented Dataclasses: guides/dataclasses.md
    - Evented Pydantic Model: guides/model.md
    - Throttling & Debouncing: guides/throttler.md
    - Coroutines (async/await): guides/async.md
    - Testing: guides/testing.md
    - Debugging: guides/debugging.md

theme:
  icon:
    logo: material/alarm-light
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - scheme: slate
      primary: blue grey
      accent: blue grey
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  features:
    - navigation.instant
    # - navigation.tabs
    # - navigation.top
    # - navigation.tracking
    - search.highlight
    - search.suggest
    # - toc.follow
    # - content.code.annotate
    - content.tabs.link
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tilde
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: "#"
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search
  - autorefs:
      resolve_closest: true
  - minify:
      minify_html: true
  - api-autonav:
      modules: ['src/psygnal']
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
          options:
            docstring_style: numpy
            filters: ["!^_"]
            show_root_heading: true
            # show_root_toc_entry: true
            show_root_full_path: true
            # show_object_full_path: false
            # show_root_members_full_path: false
            # show_category_heading: false
            # show_if_no_docstring: false
            # show_signature: true
            # show_signature_annotations: false
            show_source: true
            # show_bases: true
            # group_by_category: true
            members_order: alphabetical # alphabetical/source

            ## experimental
            # line_length: 60
            # show_submodules: true

            docstring_section_style: list # or "table"
            heading_level: 1
            merge_init_into_class: true
            parameter_headings: true
            separate_signature: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            summary: true

  - spellcheck:
      backends: # the backends you want to use
        - codespell: # or nested configs
            dictionaries: [clear, rare]

      # known_words can also be a list of words
      # known_words: known_words.txt