concurry/mkdocs.yml at mainline · amazon-science/concurry · 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
site_name: Concurry Documentation
site_description: A unified, delightful Python concurrency library
site_author: Abhishek Divekar
site_url: https://amazon-science.github.io/concurry/

repo_name: amazon-science/concurry
repo_url: https://github.com/amazon-science/concurry
edit_uri: edit/main/docs/

nav:
  - Home: index.md
  - Installation: installation.md
  - User Guide:
    - Getting Started: user-guide/getting-started.md
    - Workers: user-guide/workers.md
    - Worker Pools: user-guide/pools.md
    - Task Decorator: user-guide/task-decorator.md
    - Futures: user-guide/futures.md
    - Synchronization: user-guide/synchronization.md
    - Rate and Resource Limits: user-guide/limits.md
    - Automatic Retries: user-guide/retries.md
    - Progress Tracking: user-guide/progress.md
    - Configuration: user-guide/configuration.md
    - Gallery:
      - Overview: user-guide/gallery/index.md
      - Comprehensive LLM with Structured Parsing: user-guide/gallery/llm-with-structured-parsing.md
  - API Reference:
    - Overview: api/index.md
    - Workers: api/workers.md
    - Limits: api/limits.md
    - Retries: api/retries.md
    - Futures: api/futures.md
    - Progress: api/progress.md
  - Architecture:
    - Worker Pool System: architecture/workers.md
    - Limit System: architecture/limits.md
    - Retry System: architecture/retries.md
    - Synchronization System: architecture/synchronization.md
    - Configuration System: architecture/configuration.md
  - Contributing: contributing.md

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow
    - content.code.copy
    - content.code.select

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - footnotes
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      enabled: true
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            # General options
            show_source: true
            show_bases: true
            show_submodules: true

            # Extra options (moved from deprecated location)
            extra:
              show_inheritance: true

            # Docstring options
            docstring_style: google
            docstring_options:
              ignore_init_summary: true

            # Signature options
            show_signature_annotations: true
            signature_crossrefs: true

            # Member options
            members_order: source
            show_if_no_docstring: false

            # Heading options
            heading_level: 2
            show_symbol_type_heading: true
            show_symbol_type_toc: true

            # Filter options
            filters:
              - "!^_"  # Exclude private members
              - "!^test_"  # Exclude test functions

extra:
  version:
    provider: mike
    default: latest

extra_css:
  - stylesheets/extra.css