ibkr_event_daemon/mkdocs.yml at master · ShawnDen-coder/ibkr_event_daemon · 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
site_name: ibkr_event_daemon
repo_url: https://github.com/ShawnDen-coder/ibkr_event_daemon
site_url: https://ShawnDen-coder.github.io/ibkr_event_daemon
site_description: A lightweight event handling tool for Interactive Brokers based on the ibevent library. This project automates the process of capturing, triggering, and dispatching events from the IBKR trading platform.
site_author: Shawn Deng
edit_uri: edit/main/docs/
repo_name: ShawnDen-coder/ibkr_event_daemon
copyright: Maintained by <a href="https://github.com/ShawnDen-coder">ShawnDen-coder</a>.

nav:
  - Home: index.md
  - API Reference: reference/

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
        - docs/gen_home_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      handlers:
        python:
          paths: ["ibkr_event_daemon"]
          options:
            docstring_style: "google"
            show_source: true
            show_root_heading: true
            show_signature_annotations: true
            separate_signature: true
            show_bases: true
            merge_init_into_class: true
            docstring_section_style: "spacy"
            show_if_no_docstring: false

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - tables
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ShawnDen-coder/ibkr_event_daemon
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ibkr_event_daemon