timecopilot/mkdocs.yml at 302e9b235858f8cd79d1ef3da5cff9b56cece186 · TimeCopilot/timecopilot · 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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
site_name: ""
site_description: The GenAI Forecasting Agent · LLMs x Foundation Time Series Models
site_author: AzulGarza
strict: true
site_url: https://timecopilot.dev

repo_name: TimeCopilot/timecopilot
repo_url: https://github.com/TimeCopilot/timecopilot
edit_uri: edit/main/docs

watch:
  - "README.md"
  - timecopilot

nav:
  - Home: index.md
  - Getting Started:
      - Introduction: getting-started/introduction.md
      - Quickstart: getting-started/quickstart.md
      - Installation: getting-started/installation.md
      - Examples:
          - examples/agent-quickstart.ipynb
          - examples/llm-providers.ipynb
          - examples/aws-bedrock.ipynb
          - examples/forecaster-quickstart.ipynb
          - examples/anomaly-detection-forecaster-quickstart.ipynb
          - examples/ts-foundation-models-comparison-quickstart.ipynb
          - examples/gift-eval.ipynb
          - examples/chronos-family.ipynb
          - examples/crytpocurrency-quickstart.ipynb
  - Experiments:
      - experiments/gift-eval.md
      - experiments/fev.md
  - Documentation:
      - Time Series Model Hub: model-hub.md
      - Forecasting Parameters: forecasting-parameters.md
  - API Reference:
      - api/agent.md
      - api/forecaster.md
      - api/models/foundation/models.md
      - api/models/stats.md
      - api/models/prophet.md
      - api/models/ml.md
      - api/models/neural.md
      - api/models/ensembles.md
      - api/models/utils/forecaster.md
      - api/gift-eval/gift-eval.md
  - Changelogs:
      - changelogs/index.md
      - changelogs/v0.0.22.md
      - changelogs/v0.0.21.md
      - changelogs/v0.0.20.md
      - changelogs/v0.0.19.md
      - changelogs/v0.0.18.md
      - changelogs/v0.0.17.md
      - changelogs/v0.0.16.md
      - changelogs/v0.0.15.md
      - changelogs/v0.0.14.md
      - changelogs/v0.0.13.md
      - changelogs/v0.0.12.md
      - changelogs/v0.0.11.md
      - changelogs/v0.0.10.md
  - Community:
      - Getting Help: community/help.md
      - Contributing: contributing.md
      - Roadmap: community/roadmap.md
  - Blog:
    - blog/index.md

theme:
  name: "material"
  logo: https://timecopilot.s3.amazonaws.com/public/logos/logo-white.svg
  favicon: https://timecopilot.s3.amazonaws.com/public/logos/favicon-white.svg
  palette:
    - media: "(prefers-color-scheme)"
      primary: custom
      accent: light-blue
      toggle:
        icon: material/brightness-auto
        name: "Switch to light mode"
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: light-blue
      toggle:
        icon: material/brightness-7
        name: "Switch to dark mode"
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: light-blue
      toggle:
        icon: material/brightness-4
        name: "Switch to system preference"
  features:
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.path
    - navigation.indexes
    - navigation.sections
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
    - toc.follow

extra_css:
  - stylesheets/extra.css

markdown_extensions:
- attr_list
- admonition
- pymdownx.details
- footnotes
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
- 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
- def_list
- pymdownx.tasklist:
    custom_checkbox: true
- tables

plugins:
  - blog:
      post_url_format: "{slug}"
  - search
  - autorefs
  - mkdocs-jupyter
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          paths: [timecopilot]
          options:
            relative_crossrefs: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            group_by_category: false
            heading_level: 3
            inherited_members: true
            members: true
            merge_init_into_class: true
          extensions:
            - griffe_inherited_docstrings:
                merge: true

copyright: 2025 - TimeCopilot