kalshi-python-sdk/mkdocs.yml at main · TexasCoding/kalshi-python-sdk · 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
site_name: Kalshi Python SDK
site_description: Professional, spec-first Python SDK for the Kalshi prediction markets API
site_url: https://texascoding.github.io/kalshi-python-sdk/
repo_url: https://github.com/TexasCoding/kalshi-python-sdk
repo_name: TexasCoding/kalshi-python-sdk
edit_uri: edit/main/docs/

not_in_nav: |
  /RELEASING.md

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - content.code.copy
    - content.action.edit
    - search.suggest
    - search.highlight
  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:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_signature_annotations: true
            separate_signature: true
            docstring_style: google
            merge_init_into_class: true
            members_order: source
            filters:
              - "!^_"

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

nav:
  - Home: index.md
  - Getting Started:
    - Quickstart: getting-started.md
    - Concepts: concepts.md
    - Authentication: authentication.md
    - Configuration: configuration.md
    - Environment variables: environment-variables.md
  - Core:
    - Pagination: pagination.md
    - Types & literals: types.md
    - Request models: request-models.md
    - DataFrames: dataframes.md
    - Errors: errors.md
    - Retries & idempotency: retries.md
  - Resources:
    - Overview: resources/index.md
    - Markets: resources/markets.md
    - Events: resources/events.md
    - Series: resources/series.md
    - Exchange: resources/exchange.md
    - Historical: resources/historical.md
    - Search: resources/search.md
    - Orders: resources/orders.md
    - Portfolio: resources/portfolio.md
    - Order groups: resources/order-groups.md
    - Account: resources/account.md
    - API keys: resources/api-keys.md
    - Subaccounts: resources/subaccounts.md
    - FCM: resources/fcm.md
    - Communications (RFQ/Quote): resources/communications.md
    - Multivariate: resources/multivariate.md
    - Milestones: resources/milestones.md
    - Structured targets: resources/structured-targets.md
    - Incentive programs: resources/incentive-programs.md
    - Live data: resources/live-data.md
  - WebSocket: websockets.md
  - FIX protocol: fix.md
  - Perps: perps.md
  - Testing: testing.md
  - Migration:
    - Overview: migration.md
    - v3 → v4: migrations/v3-to-v4.md
    - v2 → v3: migrations/v2-to-v3.md
  - API Reference: reference.md