uplink/mkdocs.yml at master · prkumar/uplink · 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
site_name: Uplink
site_description: A Declarative HTTP Client for Python
repo_url: https://github.com/prkumar/uplink
repo_name: prkumar/uplink

hooks:
  - docs/plugins/main.py

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - navigation.tabs
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [uplink]
          options:
            docstring_style: google
            show_root_heading: true
            show_if_no_docstring: true
            inherited_members: true
            members_order: source
            separate_signature: true
            unwrap_annotated: true
            # preload_modules:
            # - requests
            # - aiohttp
            # - pydantic
            # - twisted
            filters:
              - "!^_"
            merge_init_into_class: true
            docstring_section_style: spacy
            signature_crossrefs: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - footnotes

nav:
  - Home: index.md
  - User Guide:
      - Introduction: user/introduction.md
      - Installation: user/install.md
      - Quickstart: user/quickstart.md
      - Authentication: user/auth.md
      - Clients: user/clients.md
      - Serialization: user/serialization.md
      - Tips & Tricks: user/tips.md
  - API Reference:
      - Overview: api/index.md
      - The Base Consumer Class: api/consumer.md
      - Decorators: api/decorators.md
      - Function Annotations: api/types.md
      - HTTP Clients: api/clients.md
      - Converters: api/converters.md
      - Authentication: api/auth.md
  - Changelog: changelog.md