redc/properdocs.yml at main · AYMENJD/redc · 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
site_name: RedC
site_url: https://redc.pages.dev
site_description: Async HTTP client for Python.
site_author: AYMEN
repo_url: https://github.com/AYMENJD/redc
repo_name: AYMENJD/redc
edit_uri: ""
copyright: Copyright &copy; 2025–2026 RedC

theme:
  name: material
  font: false
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.instant
    - navigation.top
    - content.code.copy
    - search.suggest
    - search.highlight
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Light mode

extra:
  generator: false

extra_css:
  - stylesheets/extra.css

watch:
  - docs_social_hook.py

hooks:
  - docs_social_hook.py

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            force_inspection: true
            extensions:
              - docs/griffe_native.py:AttachNative
              - docs/griffe_native.py:StripBuiltinDocs
            docstring_style: google
            docstring_options:
              warnings: false
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_root_toc_entry: true
            show_category_heading: true
            merge_init_into_class: true
            members_order: source
            heading_level: 2
            show_if_no_docstring: true
            inherited_members: false
            filters:
              - "!^_"
            separate_signature: true
            signature_crossrefs: false

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets

validation:
  nav:
    omitted_files: info
    not_found: warn
  links:
    not_found: warn
    anchors: warn
    absolute_links: relative_to_docs
    unrecognized_links: warn

nav:
  - Home: index.md
  - Getting started:
      - Installation: getting-started/installation.md
      - Quick start: getting-started/quickstart.md
  - Guides:
      - Client: guides/client.md
      - Requests: guides/requests.md
      - Response: guides/response.md
      - TLS: guides/tls.md
      - Connections: guides/connections.md
      - Streaming: guides/streaming.md
      - URL: guides/url.md
      - Errors: guides/errors.md
  - Examples: examples.md
  - API reference: reference.md