engineer/mkdocs.yml at main · quantum-like/engineer · 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# ML4T Engineer Documentation
# MkDocs Material configuration with Picasso Blue palette

site_name: ML4T Engineer
site_description: Feature engineering, labeling, alternative bars, and leakage-safe datasets for financial ML.
site_url: https://www.ml4trading.io/docs/engineer/
repo_url: https://github.com/ml4t/engineer
repo_name: ml4t/engineer

exclude_docs: |
  audit/**

# Theme configuration — vendored ML4T overlay on top of MkDocs Material
theme:
  name: material
  custom_dir: docs/overrides

  palette:
    scheme: default
    primary: custom
    accent: custom

  font: false

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

  icon:
    repo: fontawesome/brands/github

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Plugins
plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            separate_signature: true
            signature_crossrefs: true

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quickstart: getting-started/quickstart.md
  - User Guide:
    - Features: user-guide/features.md
    - Feature Discovery: user-guide/discovery.md
    - Labeling: user-guide/labeling.md
    - Alternative Bars: user-guide/bars.md
    - Dataset Builder: user-guide/dataset-builder.md
    - Preprocessing: user-guide/preprocessing.md
    - Fractional Differencing: user-guide/fractional-differencing.md
    - ML Readiness: user-guide/ml-readiness.md
  - API Reference:
    - api/index.md
  - Book Guide:
    - book-guide/index.md

# Extra configuration
extra:
  release_version: !ENV [ML4T_DOCS_VERSION, development]
  release_commit: !ENV [ML4T_DOCS_COMMIT, local]
  ml4t_docs_hub_url: /docs/
  ml4t_libraries_url: /libraries/
  ml4t_chapters_url: /chapters/

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/stefan-jansen
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/mlaboratory

  generator: false

copyright: Copyright &copy; 2024-2026 Stefan Jansen