pyhaul/properdocs.yml at main · chad-loder/pyhaul · 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
site_name: pyhaul
site_description: Resumable, cursor-based, CDN-safe HTTP downloads for Python
site_url: https://chad-loder.github.io/pyhaul/
repo_url: https://github.com/chad-loder/pyhaul
repo_name: chad-loder/pyhaul
edit_uri: edit/main/docs/

strict: true

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

hooks:
  - docs/.hooks/client_tabs.py

watch:
  - src

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.tabs.link
    - content.action.edit
    - navigation.footer
    - navigation.sections
    - navigation.expand
    - toc.follow

extra:
  version:
    provider: mike
    default: latest

extra_css:
  - stylesheets/extra.css

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

plugins:
  - search
  - mike:
      canonical_version: !ENV [DOCS_CANONICAL_VERSION, latest]
  - code-validator:
      identifiers:
        python:
          validators:
            - "python -c \"import ast,sys; ast.parse(sys.stdin.read())\""
        bash:
          validators:
            - bash -n
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            members_order: source
            docstring_style: google
            merge_init_into_class: true
            show_signature_annotations: true

nav:
  - Home: index.md
  - Quick Start: quickstart.md
  - Guides:
      - Bulk Downloads: guides/bulk-downloads.md
      - HTTP Client Adapters: guides/adapters.md
      - Retry Patterns: guides/retry.md
      - Async Usage: guides/async.md
      - Writing a Custom Adapter: guides/custom-transport.md
  - Explanation:
      - Why pyhaul Exists: explanation/why.md
      - Design & Architecture: explanation/design.md
  - Reference:
      - API: reference/api.md
      - Headers: reference/headers.md
      - Exceptions: reference/exceptions.md
      - Control File Spec: reference/spec.md
      - CLI: reference/cli.md
      - Changelog: reference/changelog.md
  - Contributing: contributing.md