minitrade/mkdocs.yml at main · dodid/minitrade · 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
site_name: Minitrade
site_description: Official Documentation for Minitrade - Simplifying Personal Trading
repo_url: https://github.com/dodid/minitrade
repo_name: "dodid/minitrade"
watch: [mkdocs.yml, docs, minitrade]
copyright: Copyright &copy; 2024 Wei Wu

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

nav:
  - "User Guide":
      - index.md
      - install.md
      - backtesting.md
      - trading.md
      - cli.md
      - Compatibility: compatibility.md
      - Contributing: contributing.md
  - "API Reference":
      - api_backtest.md
      - api_datasource.md
      - api_broker.md


theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.indexes
    - toc.follow
    - navigation.top
    # - navigation.tabs
    # - navigation.expand
  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

markdown_extensions:
  - mkdocs-click
  - attr_list
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:pymdownx.emoji.twemoji
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.highlight:
      pygments_lang_class: true
      anchor_linenums: true
  - pymdownx.inlinehilite:
      style_plain_text: python
  - pymdownx.magiclink
  - pymdownx.snippets:
      base_path: [!relative $config_dir]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - toc:
      permalink: "¤"


plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [minitrade]
          options:
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: table
            heading_level: 2
            inherited_members: false
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            line_length: 60
            summary: true
            show_source: false
            show_submodules: false
  - mkdocs-jupyter
  # - gen-files:
  #     scripts:
  #     - scripts/gen_ref_nav.py


dev_addr: "127.0.0.1:7000"

extra:
  analytics:
    provider: google
    property: G-HK9C9K1N4Q