sdk-python/mkdocs.yml at main · durable-workflow/sdk-python · 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
site_name: Durable Workflow Python SDK
site_description: API reference for durable-workflow, the Python SDK for the Durable Workflow server.
site_url: https://python.durable-workflow.com/
repo_url: https://github.com/durable-workflow/sdk-python
repo_name: durable-workflow/sdk-python
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: google
            separate_signature: true
            merge_init_into_class: true
            members_order: source
            inherited_members: true
            filters:
              - "!^_"
              - "!^to_server_command$"
              - "!^to_dict$"

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Reference:
      - Client: reference/client.md
      - Auth composition: reference/auth_composition.md
      - Worker: reference/worker.md
      - Workflow: reference/workflow.md
      - Activity: reference/activity.md
      - Errors: reference/errors.md
      - Retry policy: reference/retry_policy.md
      - Serializer: reference/serializer.md
      - External storage: reference/external_storage.md
      - External task input: reference/external_task_input.md
      - External task result: reference/external_task_result.md
      - Metrics: reference/metrics.md
      - Sync helpers: reference/sync.md
      - Testing: reference/testing.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/durable-workflow/sdk-python
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/durable-workflow/