pykka/mkdocs.yml at main · jodal/pykka · 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
site_name: Pykka
site_description: Pykka makes it easier to build concurrent applications.
site_url: !ENV READTHEDOCS_CANONICAL_URL

copyright: Copyright © 2010-2026 Stein Magnus Jodal and contributors
repo_name: jodal/pykka
repo_url: https://github.com/jodal/pykka
edit_uri: edit/main/docs/

nav:
  - Introduction:
      - index.md
  - Getting started:
      - getting-started/index.md
      - getting-started/model.md
      - getting-started/actors.md
      - getting-started/proxies.md
  - Guides:
      - guides/index.md
      - guides/logging.md
      - guides/testing.md
      - guides/deadlocks.md
      - guides/proxy-typing.md
  - Reference:
      - reference/index.md
      - reference/actors.md
      - reference/proxies.md
      - reference/futures.md
      - reference/registry.md
      - reference/runtimes.md
      - reference/exceptions.md
      - reference/messages.md
      - reference/debug.md
      - reference/typing.md
  - Examples:
      - examples/index.md
      - examples/basic.md
      - examples/proxy.md
      - examples/cooperation.md
      - examples/worker-pool.md
      - examples/mopidy.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jodal/pykka

extra_javascript:
  - javascript/readthedocs.js

markdown_extensions:
  - pymdownx.blocks.admonition
  - pymdownx.blocks.definition
  - pymdownx.highlight:
      anchor_linenums: true
      default_lang: python
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: jodal
      repo: pykka
  - pymdownx.snippets
  - pymdownx.superfences

plugins:
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
          options:
            docstring_style: google
            docstring_section_style: list
            filters:
              - "!^_[^_]"
              - "!^__post_init__"
              - "!^__len__"
              - "!^__repr__"
              - "!^__str__"
            separate_signature: true
            show_docstring_examples: true
            show_root_heading: true
            show_root_toc_entry: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_signature_annotations: true
  - search

theme:
  name: material
  features:
    - content.action.edit
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
  icon:
    logo: fontawesome/solid/spiral
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

watch:
  - docs
  - src